Sha256: 066c35e627d2f93802a33eac1050d38d2fc9bbbec31d4e3630b56f9cf4fb6dd5

Contents?: true

Size: 1.73 KB

Versions: 1

Compression:

Stored size: 1.73 KB

Contents

# Orthoses::Rails

[Orthoses](https://github.com/ksss/orthoses) extension for Ruby on Rails.
Orthoses::Rails automatically generates RBS for methods added by Rails.

## Usage

Build your Rake task for RBS generation.

```rb
$ bin/rails generate orthoses:rails:install
```

Then run the rake task.

```
$ bin/rails orthoses:rails
```

## Installation

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

    $ bundle add orthoses-rails

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

    $ gem install orthoses-rails

## Development

After checking out the repo, run `bin/setup` to install dependencies. 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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ksss/orthoses-rails. 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/ksss/orthoses-rails/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 Orthoses::Rails project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ksss/orthoses-rails/blob/main/CODE_OF_CONDUCT.md).

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
orthoses-rails-1.0.0 README.md