Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jdkato authored Feb 3, 2020
1 parent 528ee31 commit 35e9a2d
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,15 @@ BasedOnStyles = Joblint
```

See [Usage](https://github.com/errata-ai/vale/#usage) for more information.

## Using the Template

This repository serves as a [template](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) for creating your own style. The following files/folders should be edited with your own infomation:

- [`Joblint`](https://github.com/errata-ai/Joblint/tree/master/Joblint): This is where your actual style should be implemented. Re-name the folder and replace its content with your `.yml` rule files.

- [`features`](https://github.com/errata-ai/Joblint/tree/master/features) + [`fixtures`](https://github.com/errata-ai/Joblint/tree/master/fixtures): This is where your tests should reside.

- [`LICENSE`](https://github.com/errata-ai/Joblint/blob/master/LICENSE): replace with your own license information.

- [`.travis.yml`](https://github.com/errata-ai/Joblint/blob/master/.travis.yml): Replace all instances of "Joblint" with the name of your style. You'll also need to add your own [`$GITHUB_TOKEN`](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) to your [Travis CI repository settings](https://docs.travis-ci.com/user/environment-variables/#defining-variables-in-repository-settings).

0 comments on commit 35e9a2d

Please sign in to comment.