update readme

This commit is contained in:
dogeystamp 2023-01-30 22:10:56 -05:00
parent 09199ebec5
commit 80082a5b7a
Signed by: dogeystamp
GPG Key ID: 7225FE3592EFFA38

View File

@ -11,3 +11,31 @@ Currently, the following algorithms are implemented:
This uses PBKDF2 to convert a password to a key, then uses AES
to encrypt a given message.
## Installation
Clone the repo:
```
git clone https://github.com/dogeystamp/encryptme
```
Install packages:
```
npm install
```
## Running
Start development server:
```
npm run start
```
Or, compile to `dist/`:
```
npm run build
```