Holger Just
5abf10af2b
Generally, we try hard to avoid additional dependencies to external gems to keep us from having to maintain all these dependencies in the variety of environments where Rackstash is going to be used. We still decided to depend on two concurrent-ruby gems since they are 1. are of exceptional code quality 2. are well-maintained and with devs eager to maintain a stable and well-understood interface 3. provide very useful buolding-blocks for safe interoperations across thread-boundaries. The chosen versions are selected to be compatible with a wide range of external frameworks.
Rackstash
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/rackstash. To experiment with that code, run bin/console for an interactive prompt.
TODO: Delete this and the text above, and describe your gem
Installation
Add this line to your application's Gemfile:
gem 'rackstash'
And then execute:
$ bundle
Or install it yourself as:
$ gem install rackstash
Usage
TODO: Write usage instructions here
Development
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.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rackstash. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.