Readme.md in stacksondeck-1.0.0 vs Readme.md in stacksondeck-1.0.1
- old
+ new
@@ -1,10 +1,17 @@
# Stacks on Deck 
Stupid simple Chef-Rundeck integration.
+Stacks on Deck (SOD) serves up a single endpoint, which may be used as URL
+Resource Model Source in Rundeck. In the background, SOD searches for nodes on a
+Chef server using the provided knife credentials (`--config`); results are cached
+for a configurable amount of time (`--refresh`). SOD is [crash-only software](https://www.usenix.org/legacy/events/hotos03/tech/full_papers/candea/candea.pdf);
+application state is backed up to disk (`--database`). You may also wish to
+override the Rundeck user name to suit your environment (`--username`).
+
## Usage
$ sod help
Commands:
sod art # View the application art
@@ -30,11 +37,24 @@
-d, [--database=DATABASE] # Location of state database
# Default: /etc/sod.db
-u, [--username=USERNAME] # Username value for Rundeck node
# Default: ${job.username}
-r, [--refresh=N] # Refresh interval in seconds
- # Default: 900
+ # Default: 60
-l, [--log=LOG] # Log to file instead of STDOUT
-v, [--debug], [--no-debug] # Enable DEBUG-level logging
-z, [--trace], [--no-trace] # Enable TRACE-level logging
- Start application web server
+ Start application web server
+
+## API
+
+### Node Resources `GET /`
+
+Renders Chef nodes as a Rundeck Resource Model in YAML format.
+
+
+## Changelog
+
+#### v1.0.0
+
+- Stupid simple Chef-Rundeck integration
\ No newline at end of file