diff options
| author | mo khan <mo@mokhan.ca> | 2021-05-20 09:37:02 -0600 |
|---|---|---|
| committer | mo khan <mo@mokhan.ca> | 2021-05-20 09:37:02 -0600 |
| commit | 7f7ab4aac76d0bd1eb79c72300b40237a7c07e7b (patch) | |
| tree | 4e332b190db3843b711d415bb08ee7d773b770b2 | |
| parent | fe16ac8a42e0880e17bcf5500b3aa9eeccac821a (diff) | |
docs: update README
| -rw-r--r-- | README.md | 33 |
1 files changed, 13 insertions, 20 deletions
@@ -1,38 +1,31 @@ # Mpeg -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/mpeg`. To experiment with that code, run `bin/console` for an interactive prompt. - -TODO: Delete this and the text above, and describe your gem +A mini parsing expression grammar inspired by parslet. ## Installation -Add this line to your application's Gemfile: - -```ruby -gem 'mpeg' -``` - -And then execute: - - $ bundle - -Or install it yourself as: - - $ gem install mpeg +Don't! This is just for me to learn things. ## Usage -TODO: Write usage instructions here +See [Installation](#installations) ## 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 `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 `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]/mpeg. +Bug reports and pull requests are welcome on GitHub at https://github.com/xlgmokha/mpeg. ## License |