README.md in kishu-0.0.1 vs README.md in kishu-1.0.0
- old
+ new
@@ -20,12 +20,38 @@
$ gem install kishu
## Usage
-TODO: Write usage instructions here
+First setup your JWT and the host to send reports
+
+```
+export HUB_TOKEN="nsdfkhdfs89745fdfdsDFSFDS"
+export HUB_URL="https://api.test.datacite.org"
+
+```
+
+You can generate a usage report locally with:
+
+```shell
+kishu sushi generate created_by:{YOUR DATACITE CLIENT ID}
+```
+
+To generate and push a usage report in JSON format following the Code of Practice for Usage Metrics, you can use the following command.
+
+```shell
+kishu sushi push created_by:{YOUR DATACITE CLIENT ID}
+```
+
+To stream a usage report in JSON format following the Code of Practice for Usage Metrics, you can use the following command. This option should be only used with reports with more than 50,000 datasets or larger than 10MB. We compress all reports that are streammed to the the MDC Hub.
+
+```shell
+kishu sushi stream created_by:{YOUR DATACITE CLIENT ID}
+```
+
+
## Development
We use rspec for unit testing:
```
@@ -34,10 +60,10 @@
Follow along via [Github Issues](https://github.com/datacite/kishu/issues).
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kishu. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/datacite/kishu. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).