Skip to content

Commit 15fbaf3

Browse files
authored
Update README.md (#1)
1 parent b52787c commit 15fbaf3

File tree

1 file changed

+2
-16
lines changed

1 file changed

+2
-16
lines changed

README.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
# Cirro::Ruby::Client
1+
# CirroIO::Client
22

3-
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/cirro/ruby/client`. To experiment with that code, run `bin/console` for an interactive prompt.
4-
5-
TODO: Delete this and the text above, and describe your gem
3+
This gem provides access to the [Cirro REST API](https://staging.cirro.io/api-docs/v1#cirro-api-documentation).
64

75
## Installation
86

@@ -20,25 +18,13 @@ Or install it yourself as:
2018

2119
$ gem install cirro-ruby-client
2220

23-
## Usage
24-
25-
TODO: Write usage instructions here
2621

2722
## Development
2823

2924
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.
3025

3126
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).
3227

33-
## Contributing
34-
35-
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cirro-ruby-client. 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]/cirro-ruby-client/blob/master/CODE_OF_CONDUCT.md).
36-
37-
3828
## License
3929

4030
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
41-
42-
## Code of Conduct
43-
44-
Everyone interacting in the Cirro::Ruby::Client project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cirro-ruby-client/blob/master/CODE_OF_CONDUCT.md).

0 commit comments

Comments
 (0)