Skip to content

Commit

Permalink
Merge 1c6a5c0 into 525f27d
Browse files Browse the repository at this point in the history
  • Loading branch information
martindale committed Dec 29, 2015
2 parents 525f27d + 1c6a5c0 commit 5000182
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 3 deletions.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion config/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
}
};
1 change: 0 additions & 1 deletion index.js

This file was deleted.

0 comments on commit 5000182

Please sign in to comment.