update readme

fifsky · Sep 11, 2019 · 76c52b4 · 76c52b4
1 parent 224d652
commit 76c52b4
Showing 1 changed file with 13 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,14 @@
-# Html to PDF for github actions
+# HTML to PDF
 
-> test
+A github action that converts HTML files to PDF [GitHub Actions](https://github.com/features/actions).
+
+
+## ✨ Example Usage
+
+```yml
+- name: html to pdf
+  uses: fifsky/html-to-pdf-action@master
+  with:
+    htmlFile: ./public/index.html
+    outputFile: ./public/resume.pdf
+```