templates/README.md.erb in registrable-0.1.0 vs templates/README.md.erb in registrable-0.2.0
- old
+ new
@@ -4,19 +4,45 @@
### Bundler: `gem "registrable"`
### RubyGems: `gem install registrable`
-## Usage
+## Examples
+### Plugin
+
```rb
+<%= file('examples/plugin.rb') %>
+```
+
+```rb
+p Plugin.registry.keys # => [:my_plugin, :another_plugin]
+p Plugin[:my_plugin] == MyPlugin # => true
+p Plugin[:another_plugin] == AnotherPlugin # => true
+```
+
+### Role
+
+```rb
<%= file('examples/role.rb') %>
```
```rb
+other = User.new(:other)
+
+p other.role.readable? # => true
+p other.role.modifiable? # => true
+
+user = User.new(:user)
+
+p admin.role.readable? # => true
+p admin.role.modifiable? # => false
+
admin = User.new(:admin)
-p admin.role.modify? unless ENV["RSPEC"] # => true
+
+p admin.role.readable? # => true
+p admin.role.modifiable? # => true
```
## Development
* `bin/setup` to install dependencies
@@ -31,10 +57,10 @@
* `bin/rake version:bump`
* `bin/rake release` to create a git tag for the version, push git commits and tags, and push the gem to [rubygems.org](https://rubygems.org).
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/RyanScottLewis/striker.
+Bug reports and pull requests are welcome on GitHub at https://github.com/RyanScottLewis/registrable.
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