README.md in matrix-0.0.1 vs README.md in matrix-0.1.0

- old
+ new

@@ -1,14 +1,20 @@ # Matrix -This gem is under construction. +An implementation of `Matrix` and `Vector` classes. +The `Matrix` class represents a mathematical matrix. It provides methods for creating matrices, operating on them arithmetically and algebraically, and determining their mathematical properties (trace, rank, inverse, determinant). + +The `Vector` class represents a mathematical vector, which is useful in its own right, and also constitutes a row or column of a `Matrix`. + ## Installation Add this line to your application's Gemfile: - gem 'matrix' +```ruby +gem 'matrix' +``` And then execute: $ bundle @@ -18,12 +24,18 @@ ## Usage TODO: Write usage instructions here +## Development + +After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 -1. Fork it -2. Create your feature branch (`git checkout -b my-new-feature`) -3. Commit your changes (`git commit -am 'Add some feature'`) -4. Push to the branch (`git push origin my-new-feature`) -5. Create new Pull Request +Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/matrix. + +## License + +The gem is available as open source under the terms of the [2-Clause BSD License](https://opensource.org/licenses/BSD-2-Clause).