document CLI

bradshjg · Jan 7, 2020 · f7f6d8f · f7f6d8f
1 parent 855bb92
commit f7f6d8f
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/README-PYPI.md b/README-PYPI.md
@@ -10,6 +10,16 @@ STOMP meets `bottle.py`
 
 `pip install shattered`
 
+### CLI
+
+`shattered run` will run a Shattered app, using one of the following (in order):
+
+1. The `--app` flag.
+2. The `SHATTERED_APP` environment variable.
+3. `app.py` as the application module name.
+
+Use `shattered config` to see the current configuration (same app resolution as `run` command).
+
 ### Echo Server
 
 `app.py`

diff --git a/README.adoc b/README.adoc
@@ -24,6 +24,16 @@ toc::[]
 
 `pip install shattered`
 
+=== CLI
+
+`shattered run` will run a Shattered app, using one of the following (in order):
+
+1. The `--app` flag.
+2. The `SHATTERED_APP` environment variable.
+3. `app.py` as the application module name.
+
+Use `shattered config` to see the current configuration (same app resolution as `run` command).
+
 === Echo Server
 
 `app.py`