Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jdkato committed Aug 1, 2020
1 parent 6d8eadb commit 32c8009
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
@@ -1,15 +1,18 @@
# Vale: Your style, our editor

[![Financial Contributors on Open Collective](https://opencollective.com/vale/all/badge.svg?label=financial+contributors)](https://opencollective.com/vale) [![Build Status](https://img.shields.io/travis/errata-ai/vale/master.svg?style=flat-square&logo=travis)](https://travis-ci.org/errata-ai/vale) [![Go Report Card](https://goreportcard.com/badge/github.com/gojp/goreportcard?style=flat-square&logo=go&logoColor=white)](https://goreportcard.com/report/github.com/errata-ai/vale) ![GitHub All Releases](https://img.shields.io/github/downloads/errata-ai/vale/total?logo=GitHub&style=flat-square) ![Docker Pulls](https://img.shields.io/docker/pulls/jdkato/vale?color=lgreen&logo=docker&logoColor=white&style=flat-square)
Vale is a command-line tool that brings code-like linting to prose. It's cross-platform (Windows, macOS, and Linux), written in Go, and released under the MIT license. Some of its key features are:

See the [documentation](https://errata-ai.gitbook.io/vale/) for more information.
* [Markup support](https://errata-ai.gitbook.io/vale/getting-started/markup): Vale supports HTML, Markdown, AsciiDoc, reStructuredText, XML, and DITA—allowing it to avoid most syntax-related false positives while also providing .

## Contributors
* [Extensibility](https://errata-ai.gitbook.io/vale/getting-started/styles): Unlike most writing-related software, Vale's primary purpose isn't to provide its own advice; it's designed to enforce an existing style guide through its YAML-based extension system.

* [Performance](https://gist.github.com/jdkato/02bb9db72cf6d36c7a52d8b075bdb5df#file-perf-md): Vale typically takes less than 1 second to lint most files, making it fast enough to be included in test suites for large \(> 1,000 files\) repositories.

### Code Contributors
See the [documentation](https://errata-ai.gitbook.io/vale/) for more information.

[![Financial Contributors on Open Collective](https://opencollective.com/vale/all/badge.svg?label=financial+contributors&style=flat-square)](https://opencollective.com/vale) [![Build Status](https://img.shields.io/travis/errata-ai/vale/master.svg?style=flat-square&logo=travis)](https://travis-ci.org/errata-ai/vale) [![Go Report Card](https://goreportcard.com/badge/github.com/gojp/goreportcard?style=flat-square&logo=go&logoColor=white)](https://goreportcard.com/report/github.com/errata-ai/vale) ![GitHub All Releases](https://img.shields.io/github/downloads/errata-ai/vale/total?logo=GitHub&style=flat-square) ![Docker Pulls](https://img.shields.io/docker/pulls/jdkato/vale?color=lgreen&logo=docker&logoColor=white&style=flat-square)

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
<a href="https://github.com/errata-ai/vale/graphs/contributors"><img src="https://opencollective.com/vale/contributors.svg?width=890&button=false" /></a>
## Contributors

### Financial Contributors

Expand Down

0 comments on commit 32c8009

Please sign in to comment.