eslint-plugin-stronk-ts - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

package.json

 {
     "name": "eslint-plugin-stronk-ts",
-    "version": "0.0.2",
+    "version": "0.0.3",
     "main": "index.js",
@@ -5,0 +5,0 @@ "license": "MIT",

README.md

 # eslint-plugin-stronk-ts
 
-Provides a set of rules for making your types stronger in TypeScript. Meant to be used in conjunction with [stronk-ts](https://github.com/trvswgnr/stronk-ts).
+Provides a set of rules for making your types stronger in TypeScript. Meant to be used in
+conjunction with [stronk-ts](https://github.com/trvswgnr/stronk-ts).
+
+## Installation
+
+```sh
+npm install --save-dev eslint eslint-plugin-stronk-ts
+```
+
+## Usage
+
+Extend the recommended ruleset in your `.eslintrc` file:
+
+```json
+{
+    "extends": ["plugin:stronk-ts/recommended"]
+}
+```
+
+Or add `stronk-ts` to the plugins section of your `.eslintrc` configuration file. You can omit the
+`eslint-plugin-` prefix:
+
+```json
+{
+    "plugins": ["stronk-ts"]
+}
+```
+
+Configure the rules you want to use or change under the rules section:
+
+```json
+{
+    "rules": {
+        "stronk-ts/no-typeof": "off",
+        "stronk-ts/no-typeof-comparison": "error"
+    }
+}
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6806

increased by9.39%

Number of lines in readme file

41

increased by925%

No dependency changes