aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMathias Biilmann Christensen <info@mathias-biilmann.net>2016-07-05 11:38:18 -0700
committerMathias Biilmann Christensen <info@mathias-biilmann.net>2016-07-05 11:38:18 -0700
commita6a5d841fd70e9aceb6fd757450c0691f3346661 (patch)
tree80963b353263e14989f784caaadfb73fa0e4230a /README.md
parent8f6c70c51bf7e9e2045ae13c4052156877e77648 (diff)
Update dependencies and add a short README
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..560f6ed
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# Hugo + Webpack Boilerplate
+
+This is a boilerplate for using Hugo as a static site generator and Weback as the
+asset pipeline.
+
+It's setup to use post-css and babel for CSS and JavaScript.
+
+## Usage
+
+Clone this repository and run:
+
+```bash
+npm install
+npm start
+```
+
+Then visit http://localhost:3009/
+
+To build your static output, use:
+
+```bash
+npm run build
+```
+
+## Deploying to netlify
+
+Push your clone to your own GitHub repo, then start a new netlify project, pick
+your repository and configure it like this:
+
+* **Build Command:** npm run build
+* **Directory:** dist
+
+Now netlify will build and deploy your site whenever you push to git.