diff --git a/README.md b/README.md index baf86f0..5bf29b2 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,38 @@ # exchange-market Exchange market for FLO to rupee# and vise-versa + +## Run `commands` +--------------- + +``` +npm install - Install the app and node modules. +npm run help - List all commands. +npm run setup - Finish the setup (configure and reset password). +npm run configure - Configure the app. +npm run reset-password - Reset the password (for private-key). +npm run create-schema - Create schema in MySQL database. + +npm start - Start the application (main). +``` +**NOTE:** +env variable `PASSWORD` required for `npm start`. + +Windows: +``` +$env:PASSWORD=""; npm start +``` +Linux: +``` +PASSWORD=" npm start +``` +*(Optional)* +Multiple instance can be run/setup on the same dir with different config files by using env variable 'I'. + +Windows: +``` +$env:I=""; +``` +Linux: +``` +I="" +```