Sha256: 08bbf0793b023a34e5c2112131dc74eb7082db9dcc12784f69cb716999eadf0b

Contents?: true

Size: 1.87 KB

Versions: 5

Compression:

Stored size: 1.87 KB

Contents

# Mercurd

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/mercurd`. To experiment with that code, run `bin/console` for an interactive prompt.

Your benefits:

- Master the methods of code reading
- Support by a convenient command line

My Vision:

- Help to reading code
- Make code reading simple and fun

My Focus:

- Code Reading In Action

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'mercurd'
```

And then execute:

```bash
bundle
```

Or install it yourself as:

```bash
gem install mercurd
```

## 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]/mercurd. 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 Mercurd project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mercurd/blob/master/CODE_OF_CONDUCT.md).

Version data entries

5 entries across 5 versions & 1 rubygems

Version Path
mercurd-0.4.2 README.md
mercurd-0.4.1 README.md
mercurd-0.4.0 README.md
mercurd-0.3.0 README.md
mercurd-0.2.0 README.md