README.md in oxide-0.1.3 vs README.md in oxide-0.1.4
- old
+ new
@@ -3,14 +3,12 @@
[![Gem Version](https://badge.fury.io/rb/oxide.svg)](https://badge.fury.io/rb/oxide)
[![Build Status](https://travis-ci.org/rdodson41/ruby-oxide.svg?branch=master)](https://travis-ci.org/rdodson41/ruby-oxide)
[![Maintainability](https://api.codeclimate.com/v1/badges/021f4ab2eb6f6f4473b5/maintainability)](https://codeclimate.com/github/rdodson41/ruby-oxide/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/021f4ab2eb6f6f4473b5/test_coverage)](https://codeclimate.com/github/rdodson41/ruby-oxide/test_coverage)
-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/oxide`. To experiment with that code, run `bin/console` for an interactive prompt.
+The `oxide` gem is an implementation of the [Oxide Programming Language](https://github.com/rdodson41/ruby-oxide) which is written in Ruby.
-TODO: Delete this and the text above, and describe your gem
-
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -23,26 +21,22 @@
Or install it yourself as:
$ gem install oxide
-## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec 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).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `lib/oxide/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]/oxide. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rdodson41/ruby-oxide. 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 Oxide project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/oxide/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Oxide project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rdodson41/ruby-oxide/blob/master/CODE_OF_CONDUCT.md).