Github Valet

This goal of this project is to build a robot that can analyze Github repositories and report if any of the conditions outlined below are not met. The first check will involve determining whether repositories have README.md files.

Getting Started

To determine whether a Github repo has a README.md, run the following:

> github_valet = GithubValet.new
> github_valet.readme_md_exists_for?(repo_string)

A repository with a README returns true, a repository without returns false.

Prerequisites

Ruby 2.5.0

Give examples

Installing

Here's how to currently download and install

Clone the repository from github:

> git clone git@github.com:trystant/github-valet.git

Install supporting libraries with bundler

> bundle install

Use bundle exec pry to open a console

> bundle exec pry

Run GithubValet commands:

[1] pry(main)> github_valet.readme_md_exists_for?('BOWiki/BOW')
=> true

Running the tests

Github-valet uses RSpec for automated tests. The tests are run by using the command rake.

Deployment

Add additional notes about how to deploy this on a live system

Built With

• Ruby - The language used
• RSpec - RSpec
• Octokit - Octokit

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Mark Nyon - Initial work - Github Profile

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments