README.md in jekyll-translations-0.1.0 vs README.md in jekyll-translations-1.0.0

- old
+ new

@@ -1,11 +1,9 @@ # Jekyll::Translations -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/jekyll/translations`. To experiment with that code, run `bin/console` for an interactive prompt. +This is a Jekyll plugin to manage translations from a variety of sources, including AWS S3 and PO Editor. -TODO: Delete this and the text above, and describe your gem - ## Installation Add this line to your application's Gemfile: ```ruby @@ -20,16 +18,6 @@ $ gem install jekyll-translations ## Usage -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]/jekyll-translations. +If added correctly to the Gemfile, this plugin should work as a seamless replacement to local versions of the plugin that we have been using on our frontend Jekyll sites.