README.md in protonbot-memos-0.1.0 vs README.md in protonbot-memos-0.1.1
- old
+ new
@@ -1,39 +1,32 @@
# Protonbot::Memos
-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/protonbot/memos`. 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:
+Add this line to your bot's Gemfile and plugin list:
```ruby
gem 'protonbot-memos'
```
And then execute:
$ bundle
-Or install it yourself as:
-
- $ gem install protonbot-memos
-
## Usage
-TODO: Write usage instructions here
+`memo <user> <memo>` to send memo.
+`clearmemos {user}` (admin-only) to clear memos.
## 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 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]/protonbot-memos. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/handicraftsman/protonbot-memos. 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.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).