Skip to content

Commit 41eb640

Browse files
committed
Improve install instructions
Signed-off-by: Kaustav Das Modak <kaustav.dasmodak@gmail.com>
1 parent 90f6263 commit 41eb640

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,13 @@ The `develop` branch contains a full example, where the bot waits till someone r
99

1010
## Install
1111

12-
- Use the latest Node.js LTS (v14.15.0 as of this writing).
12+
- **Install Node**: Use the latest Node.js LTS (v14.15.0 as of this writing).
1313
- Make sure you have `npm` or `yarn` on the PATH.
14-
- Install depencendies: In the root directory, run `$ npm install`
15-
- Run the script using: From the same directory, run `$ node index.js`
14+
- **Install depencendies**: In the root directory, run `$ npm install`
15+
- **Add credentials**: Copy `credentials.sh` to `local.credentials.sh`, and add Matrix credentials in the new file
16+
- `local.credentials.sh` is added to `.gitignore`, so you don't have to worry about leaking your secrets
17+
- Source the file: `source local.credentials.sh`
18+
- **Run**: From the same directory, run `$ node index.js`
1619

1720
---
1821

0 commit comments

Comments
 (0)