README.md in dev_orbit-0.0.1 vs README.md in dev_orbit-0.0.2
- old
+ new
@@ -1,7 +1,10 @@
# DEV.to Interactions to Orbit Workspace
+[![Gem Version](https://badge.fury.io/rb/dev_orbit.svg)](https://badge.fury.io/rb/dev_orbit)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](code_of_conduct.md)
+
This is a Ruby gem that can be used to integrate your DEV interactions, like DEV comments on blog posts, into your organization's Orbit workspace.
## Installation
Add this line to your application's Gemfile:
@@ -42,9 +45,19 @@
```
This method will fetch all your articles from DEV, gather their respective comments, filter them for anything within the past day, and then send them to your Orbit workspace via the Orbit API.
You can run this a daily cron job, for example, to add your newest DEV comments as activities in your Orbit workspace.
+
+### CLI
+
+You can also use the built-in CLI to perform the following operations:
+
+* Check for new DEV comments and post them to Orbit
+
+```bash
+$ ORBIT_API_KEY='...' ORBIT_WORKSPACE='...' DEV_API_KEY='...' DEV_USERNAME='...' bundle exec dev_orbit --check-comments
+```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/bencgreenberg/dev_orbit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/bencgreenberg/dev_orbit/blob/master/CODE_OF_CONDUCT.md).