Commit 8378599
Changed files (1)
README.md
@@ -1,38 +1,26 @@
# Saml::Kit::Cli
-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/saml/kit/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
-Add this line to your application's Gemfile:
-
```ruby
-gem 'saml-kit-cli'
+gem install 'saml-kit-cli'
```
And then execute:
- $ bundle
-
-Or install it yourself as:
-
- $ gem install saml-kit-cli
+ $ saml-kit
## Usage
-TODO: Write usage instructions here
+ $ saml-kit
## 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).
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/saml-kit-cli.
+Bug reports and pull requests are welcome on GitHub at https://github.com/saml-kit/saml-kit-cli.
## License