README.md in bp3-hello-world-0.1.3 vs README.md in bp3-hello-world-0.1.4
- old
+ new
@@ -1,8 +1,9 @@
# Bp3::Hello::World
-Bp3::Hello::World is an example Bp3 plugin
+bp3-hello-world is an example plugin for BP3, the persuavis/black_phoebe_3
+multi-site multi-tenant rails application.
## Installation
Add this line to your application's Gemfile:
@@ -17,24 +18,32 @@
Or install it yourself as:
$ gem install bp3-hello-world
## Usage
-
+In the Rails console:
+```ruby
require 'bp3-hello-world'
Bp3::Hello::World::Context.say_it!
+```
+Under the hood, `#say_it!` uses the `I18n.locale`.
## Development
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+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.
-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 `rake install`. To release a
+new version, update the version number in `version.rb`, and then run `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).
-To install this gem onto your local machine, run `bundle exec rake install`.
+## Testing
+Run `rake` to run rspec tests and rubocop linting.
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/persuavis/bp3-hello-world.
+## Documentation
+A `.yardopts` file is provided to support yard documentation.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).