markform-cli 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +8 -2
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ![Markdown Banner](https://github.com/aryan-madan/Markform/blob/main/images/Markform%20%7C%20Banner.png?raw=true)
1
+ ![Markdown Banner](https://github.com/aryan-madan/Markform/blob/main/images/Markform%20|%20Devlog%202%20.png)
2
2
 
3
3
  Turn any folder of Markdown files into a beautiful, searchable static site — in one command.
4
4
  ```bash
@@ -9,6 +9,13 @@ I saw on reddit that people had folders of markdown files that needed to be sort
9
9
 
10
10
  ---
11
11
 
12
+ ## ⛏ Installation
13
+ ```bash
14
+ npm install -g markform-cli
15
+ ```
16
+
17
+ ---
18
+
12
19
  ## (ˆᗜˆ ) Usage
13
20
 
14
21
  **Build your site:**
@@ -23,7 +30,6 @@ markform ./my-notes -o ./output --watch
23
30
 
24
31
  ---
25
32
 
26
-
27
33
  ## (≖_≖ ) Options
28
34
 
29
35
  | Flag | Default | Description |
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "markform-cli",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Turn any folder of Markdown files into a beautiful, searchable static site.",
5
5
  "main": "src/index.js",
6
6
  "bin": {
7
- "markform": "src/index.js"
7
+ "markform": "./src/index.js"
8
8
  },
9
9
  "scripts": {
10
10
  "test": "echo \"Error: no test specified\" && exit 1"