From 35e9a2d7c9f1a94bb1b26b7f9aaed89fd8d1f69f Mon Sep 17 00:00:00 2001 From: Joseph Kato Date: Mon, 3 Feb 2020 13:43:56 -0800 Subject: [PATCH] Update README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 367cb7f..c0bae3c 100644 --- a/README.md +++ b/README.md @@ -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).