Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
searls authored Dec 12, 2023
1 parent 23d7efd commit 60225e7
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,29 @@ plugin configuration for the
as an extension to the [Standard Ruby
gem](https://github.com/standardrb/standard).

To install it, you'll want to start by adding it to your Gemfile:
## Usage

First, if you haven't already, get your app set up to [run with the `standard`
gem](https://github.com/standardrb/standard#usage)

Next, to add the `standard-rails` plugin, you'll want to start by adding it to your Gemfile:

```ruby
gem "standard-rails", group: [:development, :test]
```

## Configuration

In your `.standard.yml` file, you can simply list `standard-rails` as a plugin:
Next, in your [`.standard.yml` file](https://github.com/standardrb/standard#yaml-options),
list `standard-rails` as a plugin:

```yaml
plugins:
- standard-rails
```
## Configuration
Even though it'll usually be inferred automatically, you can specify the exact
version of Rails you want the rules to run against by converting the string to
a nested hash:
version of Rails you want the rules to be run against like this:
```yaml
plugins:
Expand Down

0 comments on commit 60225e7

Please sign in to comment.