Skip to content

Commit 6bad55e

Browse files
Update read me
1 parent b9ede1c commit 6bad55e

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,31 @@
22

33
A Vale linter style that attempts to emulate some features of the commercial, and closed source, Grammarly. More to come.
44

5-
__Not complete, and WIP, contributions welcome__.😁
5+
**Not complete, and WIP, contributions welcome**.😁
66

77
[![Build Status](https://travis-ci.org/testthedocs/Openly.svg?branch=master)](https://travis-ci.org/testthedocs/Openly) ![Vale version](https://img.shields.io/badge/vale-%3E%3D%20v1.7.0-blue.svg) ![license](https://img.shields.io/github/license/mashape/apistatus.svg)
88

99
This repository contains a [Vale-compatible](https://github.com/errata-ai/vale) that attempts to emulate some features of the commercial, and closed source, Grammarly. More to come.
1010

1111
## Getting Started
1212

13-
> :exclamation: Requires Vale >= **1.7.0**. :exclamation:
13+
### Recommended: Use Vale packages
14+
15+
Use [Vale packages](https://vale.sh/docs/keys/packages), by adding the URL of the latest download and running `vale sync`:
16+
17+
```ini
18+
# This goes in a file named either `.vale.ini` or `_vale.ini`.
19+
StylesPath = path/to/some/directory
20+
MinAlertLevel = warning # suggestion, warning or error
21+
Packages = https://github.com/ChrisChinchilla/Openly/releases/download/{LATEST_RELEASE}/Openly.zip
22+
23+
# Only Markdown and .txt files; change to whatever you're using.
24+
[*.{md,txt}]
25+
# List of styles to load.
26+
BasedOnStyles = Openly
27+
```
28+
29+
### Download manually
1430

1531
Download the [latest release](https://github.com/testthedocs/Openly/releases), copy the "Openly" directory to your `StylesPath`, and include it in your configuration file:
1632

@@ -25,4 +41,4 @@ MinAlertLevel = warning # suggestion, warning or error
2541
BasedOnStyles = Openly
2642
```
2743

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

0 commit comments

Comments
 (0)