diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 39 |
1 files changed, 0 insertions, 39 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index 467cf39..0000000 --- a/README.md +++ /dev/null @@ -1,39 +0,0 @@ -# Felflame - -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/felflame`. 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: - -```ruby -gem 'felflame' -``` - -And then execute: - - $ bundle install - -Or install it yourself as: - - $ gem install felflame - -## Usage - -TODO: Write usage instructions here - -## Development - -After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/felflame. - -## License - -The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). |