Update README
This commit is contained in:
parent
484223485d
commit
2810377a80
|
@ -5,17 +5,17 @@ With this simple script you can retrieve the access token and then use it for a
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
* The matrix server, where the account is located, needs password-login enabled
|
* The matrix server, where the account is located, needs password-login enabled
|
||||||
* local environment requires nodejs, yarn and nvm
|
* local environment requires `nodejs`, `yarn` and `nvm`
|
||||||
|
|
||||||
## Installation & setup
|
## Installation & setup
|
||||||
* `yarn install`
|
* `yarn install`
|
||||||
* `nvm use`
|
* `nvm use`
|
||||||
* run `cp config.js.example config.js`
|
* `cp config.js.example config.js`
|
||||||
* edit the `config.js`
|
* edit the `config.js`
|
||||||
|
|
||||||
## Fetching the key
|
## Fetching the key
|
||||||
* `yarn start`
|
* `yarn start`
|
||||||
The script will print the access token.
|
* The script will print the access token.
|
||||||
|
|
||||||
## Credits
|
## Credits
|
||||||
This script is based on snippets from the documentation of [matrix-bot-sdk](https://github.com/turt2live/matrix-bot-sdk)
|
This script is based on snippets from the documentation of [matrix-bot-sdk](https://github.com/turt2live/matrix-bot-sdk)
|
||||||
|
|
Loading…
Reference in a new issue