diff --git a/README.md b/README.md index 0a39c9b..d353d7c 100644 --- a/README.md +++ b/README.md @@ -14,4 +14,29 @@ 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: + +```js +var melody = require('melody'); +``` + +[maki]: https://maki.io diff --git a/config/index.js b/config/index.js index 7e42327..e3b6db3 100644 --- a/config/index.js +++ b/config/index.js @@ -19,7 +19,7 @@ module.exports = { }, services: { http: { - port: 13005 // you might want this to be 80, or 3000 + port: 3000 // you might want this to be some other port, like 80 } } }; 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');