SneakPeek

This utility let's you take a look at a remote gem's readme.

Made with <3 by @olistik.

Installation

gem install sneak_peek

Usage

sneak_peek <gem_name> --readme

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/olistik/sneak_peek. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

GNU General Public License (GPL) version 3

• gnu.org
• repository copy