Skip to content

Commit 9af1632

Browse files
committed
Readme contributing tweaks (#8)
* Fixes #5 and #4 Remove extra - Remove README column * Fixes #6 Link to projects
1 parent 0449bfa commit 9af1632

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
### Global Node Module(s)
1313

14-
* Grunt CLI - `npm install grunt-cli -g`
14+
* [Grunt CLI](https://github.com/gruntjs/grunt-cli) - `npm install grunt-cli -g`
1515

1616
### Code
1717

@@ -31,14 +31,14 @@ Run `node src/cli.js`
3131

3232
### JS
3333

34-
npm package json lint utilizes both ESLint and JSCS to enforce JavaScript standards. Please see the `.eslintrc.json` file for ESLint config and `.jscsrc` for JSCS config.
34+
npm-package-json-lint utilizes both ESLint and JSCS to enforce JavaScript standards. Please see the `.eslintrc.json` file for ESLint config and `.jscsrc` for JSCS config.
3535

3636
* [grunt-eslint](https://github.com/sindresorhus/grunt-eslint)
3737
* [grunt-jscs](https://github.com/jscs-dev/grunt-jscs)
3838

3939
#### JSON
4040

41-
npm package json lint utilizes JSON Lint to ensure JSON files are valid.
41+
npm-package-json-lint utilizes JSON Lint to ensure JSON files are valid.
4242

4343
* [grunt-jsonlint](https://github.com/brandonramirez/grunt-jsonlint)
4444

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# npm package json lint
1+
# npm-package-json-lint
22

33
A package.json linter for Node projects
44

55
## What is package json lint?
66

7-
npm package json lint helps enforce standards for your package.json file.
7+
npm-package-json-lint helps enforce standards for your package.json file.
88
Currently it can check for:
99

1010
* validity of data types in nodes. Ex: `name` should always be a string.
@@ -21,23 +21,23 @@ First thing first, let's make sure you have the necessary pre-requisites.
2121

2222
#### Node
2323

24-
* node - v4.2.0+
25-
* npm - v2.14.7+
24+
* [Node.js](https://nodejs.org/) - v4.2.0+
25+
* [npm](http://npmjs.com) - v2.14.7+
2626

2727
### Use the cli
2828

2929
* `npm install npm-package-json-lint -g`
3030

3131
## Commands and configuration
3232

33-
| Command | Alias | Description | README |
34-
|---|---|---|---|
33+
| Command | Alias | Description |
34+
|---|---|---|
3535
| pjl-cli --help | -h | Lists supported CLI options |
3636
| pjl-cli --version | -v | Lists the current version number |
37-
| pjl-cli --file <file path> | --f | File path including name. Defaults to package.json |
38-
| pjl-cli --rule <rule name> | --r | Valid rule name to check. Defaults to nothing |
39-
| pjl-cli --rules-file <file path> | --c | File path of .npmpackagejsonlintrc |
40-
| pjl-cli --ignore-warnings | --w | Ignore warnings |
37+
| pjl-cli --file <file path> | -f | File path including name. Defaults to package.json |
38+
| pjl-cli --rule <rule name> | -r | Valid rule name to check. Defaults to nothing |
39+
| pjl-cli --rules-file <file path> | -c | File path of .npmpackagejsonlintrc |
40+
| pjl-cli --ignore-warnings | -w | Ignore warnings |
4141

4242
### Examples
4343

@@ -55,7 +55,7 @@ Run using the default config on a file relative to the current working directory
5555

5656
## Lint Rules
5757

58-
npm package json lint has a configurable set of rules. Each rule contains the following properties:
58+
npm-package-json-lint has a configurable set of rules. Each rule contains the following properties:
5959

6060
1. ID - example: author-required
6161
2. Type - error or warning

0 commit comments

Comments
 (0)