README.md in dev_orbit-0.3.0 vs README.md in dev_orbit-0.4.0

- old
+ new

@@ -52,10 +52,19 @@ dev_username: '...', dev_organization: '...' ) ``` +### Performing a Historical Import + +By default, the integration will only import comments that are newer than the newest DEV comment in your Orbit workspace. You may want to perform a one-time historical import to fetch all your previous DEV comments and bring them into your Orbit workspace. To do so, instantiate your `client` with the `historical_import` flag: + +```ruby +client = DevOrbit::Client.new( + historical_import: true +) +``` ### Post New DEV Comments from a DEV User to Orbit Workspace You can use the gem to get new DEV comments on your DEV user by invoking the `#comments` method on your `client` instance: ```ruby @@ -72,11 +81,10 @@ client.organization_comments ``` This method will fetch all your organization 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. - ### Post New DEV Followers to Orbit Workspace You can use the gem to get new DEV followers by invoking the `#followers` method on your `client` instance: ```ruby @@ -104,9 +112,10 @@ * Check for new DEV organization comments and post them to Orbit ```bash $ ORBIT_API_KEY='...' ORBIT_WORKSPACE='...' DEV_API_KEY='...' DEV_ORGANIZATION='...' bundle exec dev_orbit --check-organization-comments ``` +**Add the `--historical-import` flag to your CLI command to perform a historical import of all your DEV comments using the CLI.** ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/orbit-love/community-ruby-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/orbit-love/community-ruby-dev-orbit/blob/main/CODE_OF_CONDUCT.md).