summaryrefslogtreecommitdiff
path: root/README.md
blob: 86255b5fcd6439e24048d3582a114410d1e89283 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# Straw

You can build a lot of things with straw.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'straw'
```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install straw

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/xlg-pkg/straw.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).