README.md in lex-transformer-0.1.1 vs README.md in lex-transformer-0.1.2
- old
+ new
@@ -1,43 +1,38 @@
# Legion::Extensions::Transformer
-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/legion/extensions/transformer`. To experiment with that code, run `bin/console` for an interactive prompt.
+Used to transform data to match the action for a relationship
-TODO: Delete this and the text above, and describe your gem
-
## Installation
Add this line to your application's Gemfile:
```ruby
-gem 'legion-extensions-transformer'
+gem 'lex-transformer'
```
And then execute:
$ bundle
Or install it yourself as:
- $ gem install legion-extensions-transformer
+ $ gem install lex-transformer
+## Adding to Legion
+You can manually install with a `gem install lex-transformer` command or by adding it into your settings with something like this
+```json
+{
+ "extensions": {
+ "transformer": {
+ "enabled": true, "workers": 1
+ }
+ }
+}
+```
+
## Usage
+*to be added*
-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]/legion-extensions-transformer. 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](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Legion::Extensions::Transformer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/legion-extensions-transformer/blob/master/CODE_OF_CONDUCT.md).