mirror of
https://github.com/Alamantus/otp-generator.git
synced 2025-03-22 19:38:54 +01:00
Add installation and usage to Readme
This commit is contained in:
parent
0fa0956f7e
commit
b660acac57
1 changed files with 35 additions and 1 deletions
36
README.md
36
README.md
|
@ -1,4 +1,38 @@
|
|||
# One-Time Pad Generator
|
||||
|
||||
Encrypt messages with a randomly-generated [one-time pad](https://en.wikipedia.org/wiki/One-time_pad)! Send your encrypted message along with your pad,
|
||||
and your friend can decrypt the message. Just be sure you destroy the pad when you're done!
|
||||
and your friend can decrypt the message. Just be sure you destroy the pad when you're done!
|
||||
|
||||
## Installation
|
||||
|
||||
Clone with git:
|
||||
|
||||
```
|
||||
> git clone https://github.com/Alamantus/otp-generator.git
|
||||
```
|
||||
|
||||
Go to the directory:
|
||||
|
||||
```
|
||||
> cd otp-generator
|
||||
```
|
||||
|
||||
Install dependencies with NPM or Yarn:
|
||||
|
||||
```
|
||||
> yarn
|
||||
// OR
|
||||
> npm install
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Run it:
|
||||
|
||||
```
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Open your browser and go to [http://localhost:1234](http://localhost:1234).
|
||||
|
||||
Use it!
|
||||
|
|
Loading…
Add table
Reference in a new issue