Add README

This commit is contained in:
Nikhil Nawgiri 2024-08-25 00:54:58 +02:00
parent fc614bd6cc
commit 484223485d

21
README.md Normal file
View file

@ -0,0 +1,21 @@
# fetch-matrix-access-token
## Why
The access token from Element can not be used for a different app (it seems).
With this simple script you can retrieve the access token and then use it for a different app since this script won't create any encryption.
## Requirements
* The matrix server, where the account is located, needs password-login enabled
* local environment requires nodejs, yarn and nvm
## Installation & setup
* `yarn install`
* `nvm use`
* run `cp config.js.example config.js`
* edit the `config.js`
## Fetching the key
* `yarn start`
The script will print the access token.
## Credits
This script is based on snippets from the documentation of [matrix-bot-sdk](https://github.com/turt2live/matrix-bot-sdk)