]> git.proxmox.com Git - pve-eslint.git/blobdiff - eslint/docs/README.md
import 8.41.0 source
[pve-eslint.git] / eslint / docs / README.md
index ee5f64e100ec84225ee5c8ac61c65bbe1b4a2125..dbf3c02e8f467ec2758b5e0327aed49e75868d7b 100644 (file)
@@ -1,11 +1,25 @@
 # ESLint Documentation
 
+## Install Dependencies
+
+Install the necessary dependencies for the documentation site by running this
+from the `docs` folder:
+
+```shell
+npm install
+```
+
 ## Run Locally
 
+Run this from the `docs` folder:
+
 ```shell
 npm start
 ```
 
+Once the script finishes building the documentation site, you can visit it at
+<http://localhost:2023>.
+
 ## Scripts
 
 To update the links data file, run this from the root folder (not the `docs` folder):
@@ -25,3 +39,7 @@ To autofix JS files, run this from the root folder (not the `docs` folder):
 ```shell
 npm run fix:docsjs
 ```
+
+## License
+
+© OpenJS Foundation and ESLint contributors, [www.openjsf.org](https://www.openjsf.org/). Content licensed under [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/).