README.md in codestatus-0.1.0 vs README.md in codestatus-0.1.1
- old
+ new
@@ -6,11 +6,26 @@
gem 'codestatus'
```
## Usage
+```console
+# Requires public_repo scope
+$ export CODESTATUS_GITHUB_TOKEN=XXXXXXXXXXXXXXX
+```
+
+```console
+$ codestatus status rubygems/octokit
+success
+$ codestatus status npm/react
+success
+$ codestatus status --registry=npm react
+success
+```
+
```ruby
-puts Codestatus.status('rubygems/octokit') # => success
+puts Codestatus.status(registry: 'rubygems', package: 'octokit').status # => success
+puts Codestatus.status(registry: 'npm', package: 'react').status # => success
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/meganemura/codestatus.