TODO: Delete this and the text below, and describe your gem

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/tinysky. To experiment with that code, run bin/console for an interactive prompt.

TODO: Replace UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_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.

Install the gem and add to the application's Gemfile by executing:

$ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG

TODO: Write usage instructions here

credentials = {
  app_password: "REDACTED",
  handle: "tinyskygem.bsky.social"
}
client = Tinysky::Client.new(credentials)
client.create_record("hello world!")

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 the created tag, and push the .gem file to rubygems.org.

The release process is automated but should start with a commit to update the CHANGELOG. This commit should add the new version and then update the Unreleased section back to defaults. It should also update the links. Once that's done then the actual process can be kicked off like so:

$ bin/release

Which will create a commit that bumps the patch version, push the commit to GitHub and then push the tag that triggers the release.yml workflow. That workflow will run tests and then push to RubyGems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/jonallured/tinysky.

The gem is available as open source under the terms of the MIT License.