From 1c6a5c0e29847ae74ad75b4f6210ed8c6600351b Mon Sep 17 00:00:00 2001 From: Eric Martindale Date: Tue, 29 Dec 2015 11:08:28 -0500 Subject: [PATCH] Add more instructions to README. --- README.md | 18 +++++++++++++++++- index.js | 1 - 2 files changed, 17 insertions(+), 2 deletions(-) delete mode 100644 index.js diff --git a/README.md b/README.md index d7f473a..d353d7c 100644 --- 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 deleted file mode 100644 index 9e591b2..0000000 --- a/index.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = require('./lib/melody');