Skip to content

Commit 79a4ac3

Browse files
committed
update readme
1 parent 8c18767 commit 79a4ac3

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,35 @@
11
# erblint-github
22
Template style checking for GitHub's Ruby projects
3+
4+
## Setup
5+
6+
1. Update your `Gemfile` and run `bundle install`
7+
8+
``` ruby
9+
gem "erb_lint", require: false
10+
gem "erblint-github"
11+
```
12+
13+
2. Require the linters within the `.erb-linters` folder. This could be done by adding a file `.erb-linters/erblint-github.rb` with the following line.
14+
15+
```ruby
16+
require "erblint-github/linters"
17+
```
18+
19+
3. Update the `erb-lint.yml` to configure the rule.
20+
21+
### .erb-lint.yml
22+
23+
```yaml
24+
---
25+
linters:
26+
GitHub::Accessibility::NoRedundantImageAlt:
27+
enabled: true
28+
```
29+
30+
## Testing
31+
32+
```
33+
bundle install
34+
bundle exec rake test
35+
```

0 commit comments

Comments
 (0)