README.md in noko_cli-0.1.0 vs README.md in noko_cli-0.1.1
- old
+ new
@@ -1,39 +1,25 @@
# NokoCli
-![Test Suite](https://github.com/juanvqz/noko_cli/actions/workflows/main/badge.svg)
+[![Build Status](https://github.com/juanvqz/noko_cli/workflows/main/badge.svg?branch=main)](https://github.com/juanvqz/noko_cli/actions)
-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/noko_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 the gem and add to the application's Gemfile by executing:
-
- $ bundle add noko_cli
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
- $ gem install noko_cli
-
-## 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 setup this repository you need to run `./bin/setup`
-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 the created tag, 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]/noko_cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/noko_cli/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/juanvqz/noko_cli.
+This project is intended to be a safe, welcoming space for collaboration,
+and contributors are expected to adhere to the [code of conduct](https://github.com/juanvqz/noko_cli/blob/master/CODE_OF_CONDUCT.md).
## 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 NokoCli project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/noko_cli/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the NokoCli project's codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/juanvqz/noko_cli/blob/master/CODE_OF_CONDUCT.md).