Ruby CLI tool for accessing Bluesky API / ATProto
mackuba.eu
1# Ratproto
2
3TODO: Delete this and the text below, and describe your gem
4
5Welcome 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/ratproto`. To experiment with that code, run `bin/console` for an interactive prompt.
6
7## Installation
8
9TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
10
11Install the gem and add to the application's Gemfile by executing:
12
13```bash
14bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
15```
16
17If bundler is not being used to manage dependencies, install the gem by executing:
18
19```bash
20gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
21```
22
23## Usage
24
25TODO: Write usage instructions here
26
27## Development
28
29After 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.
30
31To 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).
32
33## Contributing
34
35Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ratproto.