SnippetCli
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/snippet_cli. To experiment with that code, run bin/console for an interactive prompt.
TODO: Delete this and the text above, and describe your gem
Installation
Install it using command:
$ sudo gem install snippet_cli
Usage
TODO: Write usage instructions here
Development
This project uses devenv (Nix-based) for environment management. Do not use rbenv, rvm, asdf, or Homebrew Ruby.
First-time setup
- Install Nix and devenv
- Clone the repo:
git clone https://github.com/ajmarkow/snippet_cli.git cd snippet_cli - Enter the development environment:
devenv shell
- Install dependencies:
bundle install
- Run the tests to verify everything works:
bundle exec rake spec
Releasing a new version
- Update the version number in
lib/snippet_cli/version.rb - Commit with the message containing
gem-release-ready— CI will build and push the gem to RubyGems automatically once tests pass
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/snippet_cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
Code of Conduct
Everyone interacting in the SnippetCli project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
Copyright
Copyright (c) 2020 AJ Markow. See MIT License for further details.