README.md in harvesting-0.1.0 vs README.md in harvesting-0.2.0
- old
+ new
@@ -16,10 +16,14 @@
Or install it yourself as:
$ gem install harvesting
+## Documentation
+
+The API is documented [here](https://www.rubydoc.info/github/ombulabs/harvesting)
+
## Usage
In order to start using this gem you will need your personal token and an
account id:
@@ -90,14 +94,26 @@
## Roadmap
There are many things to be developed for this gem. For now they are tracked here: [TODO.md](https://github.com/ombulabs/harvesting/blob/master/TODO.md)
+## Releases
+
+You can find more info [here](RELEASE_NOTES.md)
+
## Development
+### Without Docker
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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`. 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### With Docker
+
+This setup allows you to create a completely isolated development environment for working on this gem. The version of ruby used for development and the gems that it depends on will remain inside the container.
+
+After checking out the repo, run `docker-compose build` to create the `gem` container. Running `docker-compose run gem bash` will get you a bash session inside the container. From there, you can follow the instructions in the "Without Docker" section above.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ombulabs/harvesting. 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.