Add more instructions to README.

martindale · Dec 29, 2015 · 1c6a5c0 · 1c6a5c0
1 parent 774d98d
commit 1c6a5c0
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -14,7 +14,23 @@ Extra config values, such as character limit and allowing public registrations,
 are available in `config/index.js` for your convenience.
 
 ## Hosting
-We strongly recommend using `pm2` to manage melody in production.
+We strongly recommend using `pm2` to manage melody in production.  You can use
+the included `melody.js` to keep your instance named clearly.  To run melody
+using `pm2`, simply:
+
+`pm2 start melody.js`
+
+Which will produce the following output:
+
+```
+┌──────────┬────┬──────┬───────┬────────┬─────────┬────────┬─────────────┬──────────┐
+│ App name │ id │ mode │ pid   │ status │ restart │ uptime │ memory      │ watching │
+├──────────┼────┼──────┼───────┼────────┼─────────┼────────┼─────────────┼──────────┤
+│ melody   │ 0  │ fork │ 25957 │ online │ 0       │ 0s     │ 10.906 MB   │ disabled │
+└──────────┴────┴──────┴───────┴────────┴─────────┴────────┴─────────────┴──────────┘
+```
+
+See `pm2 help` for other instructions, such as startup scripts and monitoring.
 
 ## Using as a Library
 melody was built with [Maki][maki], so it can also be used as a library:

diff --git a/index.js b/index.js