Skip to content

Commit

Permalink
Update readme and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisChinchilla committed Mar 12, 2020
1 parent d4ae734 commit e702779
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 26 deletions.
11 changes: 2 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
# Change Log

## [v0.2.0](https://github.com/errata-ai/Joblint/tree/v0.2.0) (2019-07-08)
[Full Changelog](https://github.com/errata-ai/Joblint/compare/v0.1.1...v0.2.0)
## [0.1.1](https://github.com/testthedocs/CockroachDB/tree/0.1.0) (2020-03-12)

## [v0.1.1](https://github.com/errata-ai/Joblint/tree/v0.1.1) (2019-06-04)
[Full Changelog](https://github.com/errata-ai/Joblint/compare/v0.1.0...v0.1.1)

## [v0.1.0](https://github.com/errata-ai/Joblint/tree/v0.1.0) (2019-06-03)


\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
Refactor repo to Vale styles template
21 changes: 4 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
# CockroachDB
A Vale linter style that replicates the [cockroachlabs.com/docs](https://cockroachlabs.com/docs).

[![Build Status](https://travis-ci.org/errata-ai/Joblint.svg?branch=master)](https://travis-ci.org/errata-ai/Joblint) ![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)

[![Build Status](https://travis-ci.org/testthedocs/CockroachDB.svg?branch=master)](https://travis-ci.org/testthedocs/CockroachDB) ![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)

This repository contains a [Vale-compatible](https://github.com/errata-ai/vale) implementation of the guidelines enforced by the [cockroachlabs.com/docs](https://cockroachlabs.com/docs) style guide.

## Getting Started

> :exclamation: Requires Vale >= **1.7.0**. :exclamation:
Download the [latest release](https://github.com/errata-ai/Joblint/releases), copy the "Joblint" directory to your `StylesPath`, and include it in your configuration file:
Download the [latest release](https://github.com/testthedocs/CockroachDB/releases), copy the "CockroachDB" directory to your `StylesPath`, and include it in your configuration file:

```ini
# This goes in a file named either `.vale.ini` or `_vale.ini`.
Expand All @@ -20,19 +19,7 @@ MinAlertLevel = warning # suggestion, warning or error
# Only Markdown and .txt files; change to whatever you're using.
[*.{md,txt}]
# List of styles to load.
BasedOnStyles = Joblint
BasedOnStyles = CockroachDB
```

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).
See [Usage](https://github.com/errata-ai/vale/#usage) for more information.

0 comments on commit e702779

Please sign in to comment.