Skip to content
This repository has been archived by the owner on Jul 18, 2021. It is now read-only.

Commit

Permalink
rename to enable publishing as action
Browse files Browse the repository at this point in the history
  • Loading branch information
kimburgess committed May 9, 2020
1 parent fb68545 commit 6c0ea3a
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 9 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
# Proofreader
# Orthograph-err

This action runs a set of proofreader tools over documentation, user guides and
other text content using the beautiful, flexible
[textlint](https://textlint.github.io/).
> An orthography is a set of conventions for writing a language. It includes
> norms of spelling, hyphenation, capitalization, word breaks, emphasis, and
> punctuation.
This action runs a set of proofreading tools over documentation, user guides and
other text content using the wonderfully flexible
[textlint](https://textlint.github.io/), flagging any orthograpic errors.

## Usage

Your repository should contain a [textlint configuration
file](https://textlint.github.io/docs/configuring.html).

```yaml
- uses: place-labs/proofreader@master
- uses: place-labs/orthograph-err@v1
with:
# File path with the content to review.
# Default: {,!(node_modules)/**/}*.md
Expand Down Expand Up @@ -44,7 +48,7 @@ For an example of this action in use, see
- [write-good](https://github.com/textlint-rule/textlint-rule-write-good)
To add rules engines [fork this
repo](https://github.com/place-labs/proofreader/fork), then `npm install
repo](https://github.com/place-labs/orthograph-err/fork), then `npm install
<rule>`.

If it's a commonly useful rule, PR's are open <3.
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: 'Proofreader'
name: 'Orthograph-err'
description: 'Automated docs reviewer. Robotic grammar enthusiast.'
inputs:
path:
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{
"name": "proofreader",
"name": "orthograph-err",
"version": "1.0.0",
"description": "",
"repository": "https://github.com/place-labs/orthograph-err",
"main": "src/index.js",
"license": "MIT",
"dependencies": {
Expand Down

0 comments on commit 6c0ea3a

Please sign in to comment.