Add basic README.md

README.md

@@ -0,0 +1,17 @@
+# SaltStatus
+
+This is a small webapp to render the events from salt in a compact, readable format. I wrote it to deal with running `state.apply` on all the Windows laptops and desktops at the Claremont MakerSpace, as the CLI results were becoming hard to parse by hand.
+
+## Usage
+
+You will need credentials on the salt master. Place these in a file called `credentials.json` in the `src/` directory, as per the following example:
+
+```json
+{
+  "username": "user",
+  "password": "password",
+  "eauth": "pam"
+}
+```
+
+Then `npm install` and `npm start` should bring the webapp up on parcel's default port 1234. You may need to go to a page on the api (there should one be printed out in the error the js console) to accept the SSL certificate.