Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Update README with examples
  • Loading branch information
hchasestevens authored Feb 26, 2018
1 parent 9a0d4e5 commit a690f70
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,12 @@ Additionally, at the root level of `.bellybutton.yml`, a `default_settings` sett
will be used by rules without explicit settings. Each rule must either have a `settings` parameter or be
able to fall back on the `default_settings`.

## Example usage:

Check out this repository's [`.bellybutton.yml`](.bellybutton.yml) as an example `bellybutton` configuration file,
and [`astpath`'s README](https://github.com/hchasestevens/astpath/blob/master/README.md) for examples of the types
of patterns you can lint for using `bellybutton`.

## Development status

`bellybutton` is in an alpha release and, as such, is missing some key features, documentation,
Expand Down

0 comments on commit a690f70

Please sign in to comment.