Add some readme

formspree · Oct 17, 2019 · 0988221 · 0988221
1 parent 9a01e6e
commit 0988221
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,25 @@
 # StaticKit CLI [![CircleCI](https://circleci.com/gh/unstacked/statickit-cli.svg?style=svg)](https://circleci.com/gh/unstacked/statickit-cli)
+
+The command line interface for [StaticKit](https://statickit.com).
+
+## Installation
+
+Run the following to install in your project:
+
+```bash
+npm install --save-dev @statickit/cli
+```
+
+Then, run the `statickit` command:
+
+```bash
+npx statickit deploy
+```
+
+## Releasing
+
+Run the following to publish a new version:
+
+```bash
+npm run release
+```