Update the documentation for the ruby gem

2 files changed, 38 insertions, 30 deletions

diff --git a/CLI/ruby/README.md b/CLI/ruby/README.md
index 58d1cfd..99bb57e 100644
--- a/CLI/ruby/README.md
+++ b/CLI/ruby/README.md
@@ -1,44 +1,29 @@
 # GameOfLife
 
-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/game_of_life`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+The implementation of the [Conway's Game of Life](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life) ruby CLI gem
 
 ## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'game_of_life'
+```bash
+$ gem install game_of_life
 ```
 
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install game_of_life
-
 ## Usage
 
-TODO: Write usage instructions here
+Check `game-of-life --help` for usage info.
 
 ## 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]/game_of_life. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/game_of_life/blob/master/CODE_OF_CONDUCT.md).
-
-
-## License
+- Clone the repo.
+- Navigate to the ruby CLI implementation `cd game-of-life/CLI/ruby`.
+- run `bundle install` to install dependencies.
+- run `bundle rake build` to build the gem/CLI into the `pkg` directory.
+- run `bundle rake install` to build and install gem/CLI into system gems.
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+## Testing
 
-## Code of Conduct
+Run `bundle exec rspec` or `bundle exec rake spec`
 
-Everyone interacting in the GameOfLife project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/game_of_life/blob/master/CODE_OF_CONDUCT.md).
+## Extra information
+### [Contributing](../../CONTRIBUTING.md)
+### [License](../../LICENSE.md)
+### [Code of Conduct](../../CODE_OF_CONDUCT.md)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..7a02188
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,23 @@
+# Contributing to Game of Life
+
+Contribution to this project is welcome 
+
+## General Guidelines
+
+Please read the [Code of Conduct](./CODE_OF_CONDUCT.md)<br/>
+Please read these blog posts (which frame the philosophies that we are trying to follow, to keep things simple/clean and maintainable)
+
+- [Write code that is easy to delete, not easy to extend](https://programmingisterrible.com/post/139222674273/write-code-that-is-easy-to-delete-not-easy-to)
+- [Write code that is easy to delete, and easy to debug too](https://programmingisterrible.com/post/173883533613/code-to-debug)
+- [Repeat yourself, do more than one thing, and rewrite everything](https://programmingisterrible.com/post/176657481103/repeat-yourself-do-more-than-one-thing-and)
+
+## Contribute to the code base 
+
+1. Fork this repository to your own account and then clone it to your local device.
+2. Create a new branch `git checkout -b MY_BRANCH_NAME`
+3. Install the dependencies based on which language you are modifying (or adding support to).
+4. Do your changes.
+5. Run the tests bundled with the language.
+6. Commit your changes and push them.
+7. Create a pull/merge request.
+8. Thanks in advance for your contribution :)