diff --git a/README.md b/README.md index 5ac6318..bc20a0e 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,23 @@ # Nostr -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/nostr`. To experiment with that code, run `bin/console` for an interactive prompt. +Nostr client. Please note that the API is likely to change as the gem is still in development and has not yet reached a +stable release. Use with caution. ## Installation -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 + $ bundle add nostr 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 + $ gem install nostr ## Usage -TODO: Write usage instructions here +```ruby +require 'nostr' +``` ## Development @@ -49,7 +48,9 @@ rake yardstick_measure # Measure docs in lib/**/*.rb with yardstick ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/wilsonsilva/nostr. 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/wilsonsilva/nostr/blob/main/CODE_OF_CONDUCT.md). +Bug reports and pull requests are welcome on GitHub at https://github.com/wilsonsilva/nostr. +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/wilsonsilva/nostr/blob/main/CODE_OF_CONDUCT.md). ## License @@ -57,4 +58,5 @@ The gem is available as open source under the terms of the [MIT License](https:/ ## Code of Conduct -Everyone interacting in the Nostr project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/wilsonsilva/nostr/blob/main/CODE_OF_CONDUCT.md). +Everyone interacting in the Nostr project's codebases, issue trackers, chat rooms and mailing lists is expected +to follow the [code of conduct](https://github.com/wilsonsilva/nostr/blob/main/CODE_OF_CONDUCT.md).