chore: readme fixes and deps bump (#8)

NeuraLegion · Mar 23, 2021 · a797c20 · a797c20
1 parent 741fa23
commit a797c20
Show file tree

Hide file tree

Showing 4 changed files with 1,804 additions and 2,288 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -6,8 +6,7 @@
   "extends": [
     "plugin:@typescript-eslint/eslint-recommended",
     "plugin:@typescript-eslint/recommended",
-    "prettier",
-    "prettier/@typescript-eslint"
+    "prettier"
   ],
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
@@ -22,6 +21,7 @@
     "@typescript-eslint/await-thenable": "error",
     "@typescript-eslint/no-for-in-array": "error",
     "@typescript-eslint/no-misused-promises": "error",
+    "@typescript-eslint/no-shadow": "error",
     "@typescript-eslint/prefer-includes": "error",
     "@typescript-eslint/prefer-regexp-exec": "error",
     "@typescript-eslint/prefer-string-starts-ends-with": "error",
@@ -215,12 +215,6 @@
     "no-multiple-empty-lines": "error",
     "no-new-wrappers": "error",
     "no-restricted-syntax": ["error", "ForInStatement"],
-    "no-shadow": [
-      "error",
-      {
-        "hoist": "all"
-      }
-    ],
     "no-throw-literal": "error",
     "no-trailing-spaces": "error",
     "no-undef-init": "error",

diff --git a/README.md b/README.md
@@ -86,7 +86,7 @@ Return un-abbreviated metric value: e.g. 'Network' for input ('AV', 'N')
 <summary>ECMAScript 2015, Typescript modules</summary>
 
 ```
-import { calculateBaseScore } from 'cvss';
+import { calculateBaseScore } from '@neuralegion/cvss';
 
 console.log('score: ', calculateBaseScore('CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:C/C:H/I:N/A:N'));
 ```
@@ -96,7 +96,7 @@ console.log('score: ', calculateBaseScore('CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:C/C:H/
 <summary>NodeJS (CommonJS module)</summary>
 
 ```
-const cvss = require('cvss');
+const cvss = require('@neuralegion/cvss');
 
 console.log(cvss.calculateBaseScore('CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:C/C:H/I:N/A:N'));
 ```
@@ -109,7 +109,7 @@ console.log(cvss.calculateBaseScore('CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:C/C:H/I:N/A:
 `usage.mjs` file:
 
 ```
-import cvss from 'cvss';
+import cvss from '@neuralegion/cvss';
 
 console.log(cvss.calculateBaseScore('CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:C/C:H/I:N/A:N'));
 ```
@@ -122,7 +122,7 @@ Running: `node --experimental-modules ./usage.mjs`
 <summary>Browser (globals from umd bundle)</summary>
 
 ```
-<script src="./node_modules/cvss/dist/bundle.umd.js"></script>
+<script src="./node_modules/@neuralegion/cvss/dist/bundle.umd.js"></script>
 <script>
   alert(`Score: ${cvss.calculateBaseScore('CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:C/C:H/I:N/A:N')}`);
 </script>
@@ -134,7 +134,7 @@ Running: `node --experimental-modules ./usage.mjs`
 
 ```
 <script type="module">
-  import { calculateBaseScore } from './node_modules/cvss/dist/bundle.es.js';
+  import { calculateBaseScore } from './node_modules/@neuralegion/cvss/dist/bundle.es.js';
   alert(`Score: ${calculateBaseScore('CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:C/C:H/I:N/A:N')}`);
 </script>
 ```