Merge pull request #99 from github/remove-scripts

Remove scripts
github · Mar 23, 2020 · ccd340b · ccd340b
2 parents f547093 + 268bb01
commit ccd340b
Show file tree

Hide file tree

Showing 8 changed files with 62 additions and 515 deletions.
diff --git a/README.md b/README.md
@@ -3,25 +3,36 @@
 ## Installation
 
 ```sh
-$ npm install --save-dev eslint
-$ npm install --save-dev eslint-plugin-github
+$ npm install --save-dev eslint eslint-plugin-github
 ```
 
-Run initialization wizard.
+## Setup
 
-```sh
-$ node_modules/.bin/eslint-github-init
+Add `github` to your list of plugins in your ESLint config.
+
+JSON ESLint config example:
+```json
+{
+  "plugins": ["github"]
+}
 ```
 
-Set up `npm run lint` script.
+Extend the configs you wish to use.
 
+JSON ESLint config example:
 ```json
 {
-  "private": true,
-  "scripts": {
-    "lint": "github-lint"
-  }
+  "extends": ["plugin:github/recommended"]
 }
 ```
 
-The `github-lint` command will run various checkers and linters depending on your project configuration.
+The available configs are:
+
+- `app`
+  - Rules useful for github applications.
+- `browser`
+  - Useful rules when shipping your app to the browser.
+- `recommended`
+  - Recommended rules for every application.
+- `typescript`
+  - Useful rules when writing TypeScript.
diff --git a/bin/eslint-github-init.js b/bin/eslint-github-init.js
diff --git a/bin/github-lint.js b/bin/github-lint.js
diff --git a/bin/npm-check-github-package-requirements.js b/bin/npm-check-github-package-requirements.js
diff --git a/docs/configs.md b/docs/configs.md
diff --git a/docs/package-requirements.md b/docs/package-requirements.md