diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5d0e8b0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# Obsidian Link Scrapper
+GitHub action and binary to scrape [Obsidian](http://obsidian.md/) vault for links and exposes them as a `.yml` file for easy consumption by [Hugo](https://gohugo.io/).
+
+## Installation
+`go install github.com/jackyzha0/hugo-obsidian`
+
+### Example Usage
+Read Markdown from the `/content` folder and place the resulting `linkIndex.yaml` into `/data`
+
+```shell
+hugo-obsidian -input=content -output=data
+```
\ No newline at end of file