Skip to content

Commit 90f6263

Browse files
committed
Add install details
Signed-off-by: Kaustav Das Modak <kaustav.dasmodak@gmail.com>
1 parent 8de1df9 commit 90f6263

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ This repository contains a simple Matrix client written in JavaScript to run in
77

88
The `develop` branch contains a full example, where the bot waits till someone replies back "hello".
99

10+
## Install
11+
12+
- Use the latest Node.js LTS (v14.15.0 as of this writing).
13+
- 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`
16+
1017
---
1118

12-
License: Public domain
19+
License: Unlicense/Public domain

0 commit comments

Comments
 (0)