Skip to content

Commit

Permalink
README.md: Use Windows file paths.
Browse files Browse the repository at this point in the history
This is to be consistent since the GIF was taken on Windows and all of the examples should be using the same format.
  • Loading branch information
samuel-lucas6 authored Jul 5, 2021
1 parent 2b4edc4 commit b6e649f
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,23 +60,23 @@ Examples:
```

### Specifying files
When referencing file paths/file names that contain spaces, you must surround them with 'apostrophes' on Linux/macOS and "speech marks" on Windows:
When referencing file paths/file names that contain spaces, you must surround them with "speech marks" on Windows and 'apostrophes' on Linux/macOS:
```
$ kryptor -e -p 'GitHub Logo.png'
$ kryptor -e -p '/home/samuel/Downloads/GitHub Logo.png'
$ kryptor -e -p "GitHub Logo.png"
$ kryptor -e -p "C:\Users\samuel-lucas6\Downloads\GitHub Logo.png"
```
Files in the same directory as the ```kryptor``` executable can be specified using their file name:
```
$ kryptor -e -p message.txt
```
However, files that are not in the same directory as the ```kryptor``` executable must be specified using a file path:
```
$ kryptor -e -p /home/samuel/Documents/message.txt
$ kryptor -e -p C:\Users\samuel-lucas6\Documents\message.txt
```
### Specifying your private key
You can use the `-x|--private` option without specifying a file path to use your default private key. This is the recommended approach, but it means your private keys must be kept in the default folder.

To specify a non-default private key, you can use `-x|--private` followed by `=[file]` like so:
```
$ kryptor -e -x=C:\Users\Samuel\.kryptor\encryption.private message.txt
$ kryptor -e -x=C:\Users\samuel-lucas6\Documents\encryption.private message.txt
```

0 comments on commit b6e649f

Please sign in to comment.