Update README & workflow

ksw2000 · ksw2000 · commit c9d241a31aa7 · 2021-12-07T01:56:42.000+08:00
diff --git a/.github/workflows/gitpage.yml b/.github/workflows/gitpage.yml
@@ -7,7 +7,7 @@ on:
     branches: [ main ]
 
 jobs:
-  deploy:
+  gitpage:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -29,5 +29,5 @@ jobs:
           git remote add secure-origin https://${{ secrets.NPM_CI }}@github.com/liao2000/${{ github.event.repository.name }}
           git checkout -b gh-pages
           git add .
-          git commit -m "Automatically generated by CI"
+          git commit -m "Generated by CI"
           git push --force secure-origin gh-pages
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -4,7 +4,7 @@ on:
   release:
     types: [created]
 jobs:
-  build:
+  publish:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,3 @@
+.github/
+.gitattributes
+example/
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
@@ -1,7 +1,93 @@
 # HackMD to HTML cli
 
+![](https://img.shields.io/github/workflow/status/liao2000/HackMD-to-HTML/publish?style=flat-square) 
+[![NPM version](https://img.shields.io/npm/v/hackmd-to-html-cli.svg?style=flat-square)](https://www.npmjs.org/package/hackmd-to-html-cli)
+
 A simple Node.js wrapper for `markdown-it`. This tool helps to convert HackMD markdown files to HTML files.
 
+> See DEMO: [https://liao2000.github.io/HackMD-to-HTML/](https://liao2000.github.io/HackMD-to-HTML/)
+
+## Install
+
+```sh
+npm install -g hackmd-to-html-cli
+```
+
+## Usage
+
+```sh
+$ hmd2html --help
+hmd2html --help
+Usage: index [options]
+
+Options:
+  -v, --version                    output the current version
+  -s, --source <files_or_dirs...>  specify the input markdown files or directories
+  -d, --destination <path>         specify the output directory (default: ./output)
+  -l, --layout <html_file>         specify the layout file (default: "")
+  -h, --help                       display help for command
+```
+
+### Convert
+
+```sh
+# files
+$ hmd2html -s file1.md file2.md file3.md
+
+# directories
+$ hmd2html -s ./dir1 ./dir2
+
+# files or directories
+
+$ hmd2html -s file1.md ./dir1
+```
+
+### Set output folder
+
+```sh
+$ hmd2html -s file1.md -d ./out
+```
+
+### Use custom layout
+
+
+```sh
+$ hmd2html -s hello.md -l ./myLayout.html
+```
+
++ /
+    + output
+        + hello.html
+    + hello.md
+    + myLayout.html
+
+**myLayout.html**
+```html
+<html>
+    <head></head>
+    <body>
+        {{main}}
+    </body>
+</html>
+```
+
+**hello.md**
+```markdown
+# hello
+```
+
+**hello.html**
+```html
+<html>
+    <head></head>
+    <body>
+        <h1>hello</h1>
+    </body>
+</html>
+```
+
 ## TODO
 
-+ publish to npm
++ Provide more template & styles
++ Automatically generate HTML `<title>`
++ Support more HackMD syntax

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+.github/`
	`2`	`+.gitattributes`
	`3`	`+example/`