Skip to content

Commit

Permalink
updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nodesocket committed Oct 2, 2017
1 parent b9ec527 commit 2c643c4
Showing 1 changed file with 21 additions and 12 deletions.
33 changes: 21 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,46 +4,55 @@

## Installation

````
```
git clone https://github.com/nodesocket/cryptr.git
ln -s "$PWD"/cryptr/cryptr.bash /usr/local/bin/cryptr
````
```

## API/Commands

### encrypt

> encrypt \<file\> - Encryptes file with OpenSSL AES-128 cipher block chaining. Writes an encrypted file out *(ciphertext)* appending `.aes` extention.
> encrypt \<file\> - Encryptes file with OpenSSL AES-128 cipher block chaining. Writes an encrypted file out *(ciphertext)* appending `.aes` extension.
````
```
➜ cryptr encrypt ./secrets-file
enter aes-128-cbc encryption password:
Verifying - enter aes-128-cbc encryption password:
```

```
➜ ll
-rw-r--r-- 1 user group 1.0G Oct 1 13:33 secrets-file
-rw-r--r-- 1 user group 1.0G Oct 1 13:34 secrets-file.aes
````
```


### decrypt

> decrypt \<file.aes\> - Decrypt encrypted file using OpenSSL AES-128 cipher block chaining. Writes a decrypted file out *(plaintext)* removing `.aes` extention.
> decrypt \<file.aes\> - Decrypt encrypted file using OpenSSL AES-128 cipher block chaining. Writes a decrypted file out *(plaintext)* removing `.aes` extension.
````
```
➜ ll
-rw-r--r-- 1 user group 1.0G Oct 1 13:34 secrets-file.aes
```

```
➜ cryptr decrypt secrets-file.aes
enter aes-128-cbc decryption password:
```

```
➜ ll
-rw-r--r-- 1 user group 1.0G Oct 1 13:35 secrets-file
-rw-r--r-- 1 user group 1.0G Oct 1 13:34 secrets-file.aes
````
```

### help

> help - Displays help
````
```
➜ cryptr help
Usage: cryptr command <command-specific-options>
Expand All @@ -52,16 +61,16 @@ Usage: cryptr command <command-specific-options>
help Displays help
version Displays the current version
````
```

### version

> version - Displays the current version
````
```
➜ cryptr version
cryptr 1.0.0
````
```

### default

Expand Down

0 comments on commit 2c643c4

Please sign in to comment.