markdown-list-linter-cli - npm Package Compare versions

Comparing version 0.0.5 to 0.0.6

package.json

 {
   "name": "markdown-list-linter-cli",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "CLI tool to lint markdown lists to warn when list items are not alphabetically ordered",
@@ -32,3 +32,15 @@ "main": "lib/index.min.js",
   "keywords": [
-    "markdown"
+    "markdown",
+    "markdown cli",
+    "markdown linter",
+    "cli tool for markdown files",
+    "cli tool",
+    "markdown lists",
+    "markdown list linter",
+    "alphabetically order markdown list",
+    "sort markdown lists",
+    "order markdown lists",
+    "cli tool to order markdown list",
+    "cli tool to sort markdown list",
+    "cli tool to alphabetically sort markdown list"
   ],
@@ -35,0 +47,0 @@ "dependencies": {

README.md

@@ -1,1 +0,76 @@
-Todo
+# Markdown List Linter
+
+Command line interface (CLI) tool to lint markdown lists and warn when list items are not alphabetically ordered.
+
+## A complete solution
+
+This functionality is available to be consumed in three different ways:
+
+* ⚡ [A GitHub Action](https://github.com/marketplace/actions/markdown-list-linter) as part of your CI/CD process
+
+* 📦 [An NPM package](https://www.npmjs.com/package/markdown-list-linter) that can be consumed in your JavaScript or TypeScript code
+
+* 💻 [A CLI](https://www.npmjs.com/package/markdown-list-linter-cli) that you can run in your terminal
+
+## Installation
+
+You can install this CLI tool globally.
+
+```shell
+npm install markdown-list-linter-cli -g
+```
+
+## Usage
+
+Very simple to use all results will be printed in the terminal.
+
+```ps
+> markdown-list-linter -f ./data/valid_file.md
+```
+
+When there are no errors the returned object should look something like this.
+
+```
+SUMMARY:
+No errors found
+```
+
+If you supply a markdown file which has a list that needs to be sorted.
+
+```ps
+> markdown-list-linter -f ./data/invalid_file.md
+```
+
+When there are errors the returned object should look something like this.
+
+```
+SUMMARY:
+Markdown list needs to be sorted
+            
+DETAILS:
+Please correct the alphabetical order for these heading items
+    Section #1
+        D
+        A
+        B
+        C
+
+Please correct the alphabetical order for these list items
+    Section #1
+        African Buffalo
+        Aardwolf
+
+    Section #2
+        Chameleon
+        Camel
+        Cheetah
+        Canary
+```
+
+The items in each section are the items in the list which need to be reordered. 
+
+For help command, type the following.
+
+```ps
+> markdown-list-linter -h
+```

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

5338

increased by63.29%

Number of lines in readme file

76

increased by7500%

No dependency changes