README.md in jot-ruby-js-0.1.3 vs README.md in jot-ruby-js-0.1.4
- old
+ new
@@ -1,16 +1,15 @@
# Jot::Ruby::Js
-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/jot/ruby/js`. To experiment with that code, run `bin/console` for an interactive prompt.
+This library is an adapter for Joshua Tauberer OT library https://github.com/JoshData/jot
-TODO: Delete this and the text above, and describe your gem
-
## Installation
Add this line to your application's Gemfile:
```ruby
+gem 'mini_racer' # or 'therubyracer' for example
gem 'jot-ruby-js'
```
And then execute:
@@ -20,24 +19,22 @@
$ gem install jot-ruby-js
## Usage
-TODO: Write usage instructions here
+```ruby
+require 'jot/ruby/js'
-## Development
+```
+then use any operation described at [bombazook/jot-ruby](https://github.com/bombazook/jot-ruby) and [JoshData/jot](https://github.com/JoshData/jot)
-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]/jot-ruby-js. 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).
+The gem is available under the terms of the [GPL v3 License](http://choosealicense.com/licenses/gpl-v3/)
## Code of Conduct
Everyone interacting in the Jot::Ruby::Js project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jot-ruby-js/blob/master/CODE_OF_CONDUCT.md).