diff --git a/README.md b/README.md index b36bf00..0b928d0 100644 --- a/README.md +++ b/README.md @@ -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 +```