Skip to content

Commit

Permalink
Merge pull request #6 from krystal/docs/private-repo-setup
Browse files Browse the repository at this point in the history
chore(docs): expand instructions for first-time setup
  • Loading branch information
bencromwell authored Oct 17, 2024
2 parents 265d812 + e62cef7 commit aed97cb
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,25 @@ This repository contains a [Vale-compatible](https://vale.sh/) implementation of

## Getting Started

### I have a `vale.ini` already

To get started, add the package to your configuration file (as shown below) and then run `vale sync`.

```ini
StylesPath = styles # Use your normal style path here.
Packages = https://github.com/krystal/vale-package/releases/latest/download/vale.zip
```

### Add Vale to a project

Create a `.vale.ini` at the project's root:
```ini
StylesPath = vale-styles # Location of styles directory
MinAlertLevel = suggestion # Options: suggestion, warning, error
Packages = https://github.com/krystal/vale-package/releases/latest/download/vale.zip

[*.md] # Apply to markdown files
BasedOnStyles = Krystal
```

See [Vale's documentation on packages](https://vale.sh/docs/topics/packages/) for more information.

0 comments on commit aed97cb

Please sign in to comment.