diff options
| author | mokha <mokha@cisco.com> | 2018-02-13 19:03:31 -0700 |
|---|---|---|
| committer | mokha <mokha@cisco.com> | 2018-02-13 19:03:31 -0700 |
| commit | 5401de49dcd25e6b6fcd7d9fef9fd847608cfab4 (patch) | |
| tree | b516df24f94d9cc0361cff40c3127cf58da49486 /README.md | |
initial commit.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..94a24b1 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Xsay + +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/xsay`. 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 'xsay' +``` + +And then execute: + + $ bundle + +Or install it yourself as: + + $ gem install xsay + +## 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](https://rubygems.org). + +## Contributing + +Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/xsay. + +## License + +The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). |
