67 lines
2.7 KiB
Markdown
67 lines
2.7 KiB
Markdown
# Nostr
|
|
|
|
[](https://badge.fury.io/rb/nostr)
|
|
[](https://codeclimate.com/github/wilsonsilva/nostr/maintainability)
|
|
[](https://codeclimate.com/github/wilsonsilva/nostr/test_coverage)
|
|
|
|
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
|
|
|
|
Install the gem and add to the application's Gemfile by executing:
|
|
|
|
$ bundle add nostr
|
|
|
|
If bundler is not being used to manage dependencies, install the gem by executing:
|
|
|
|
$ gem install nostr
|
|
|
|
## Usage
|
|
|
|
```ruby
|
|
require 'nostr'
|
|
```
|
|
|
|
## Development
|
|
|
|
After checking out the repo, run `bin/setup` to install dependencies.
|
|
|
|
To install this gem onto your local machine, run `bundle exec rake install`.
|
|
|
|
You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
|
|
|
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).
|
|
|
|
The health and maintainability of the codebase is ensured through a set of
|
|
Rake tasks to test, lint and audit the gem for security vulnerabilities and documentation:
|
|
|
|
```
|
|
rake bundle:audit # Checks for vulnerable versions of gems
|
|
rake qa # Test, lint and perform security and documentation audits
|
|
rake rubocop # Lint the codebase with RuboCop
|
|
rake rubocop:auto_correct # Auto-correct RuboCop offenses
|
|
rake spec # Run RSpec code examples
|
|
rake verify_measurements # Verify that yardstick coverage is at least 100%
|
|
rake yard # Generate YARD Documentation
|
|
rake yard:junk # Check the junk in your YARD Documentation
|
|
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).
|
|
|
|
## 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 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).
|