docs: add README

README.md

@@ -0,0 +1,47 @@
+# Code Review Leaderboard
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/code_review_leaderboard`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Install the gem:
+
+    $ gem install code_review_leaderboard
+
+## Usage
+
+To use the gem, you will need to provide a GitHub access token. You can create a new access token by following the instructions [here](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). If you want to inspect the repositories of an organization, make sure the organization in question allows access to their repositories from personal access tokens. You can check that from `https://github.com/organizations/<name>/settings/personal-access-tokens`.
+
+To see a help message, run:
+
+    $ code_review_leaderboard --help
+
+To inspect the reviews of a single repository, run:
+
+    $ code_review_leaderboard --access_token ACCESS_TOKEN --repository REPOSITORY
+
+You can also provide multiple repositories:
+
+    $ code_review_leaderboard --access_token ACCESS_TOKEN --repository REPOSITORY1 REPOSITORY2
+
+Finally, you can also inspect the repositories of an organization:
+
+    $ code_review_leaderboard --access_token ACCESS_TOKEN --organization ORGANIZATION
+
+The gem will consider reviews completed within the last 30 days.
+
+## Configuration
+
+You can either configure the gem via command line arguments or by setting environment variables. Command line arguments take precedence.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. You can then run it with `bundle exec <executable>`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/markokajzer/code_review_leaderboard.