From b6e649f709a1eac1fbd023f99c5ab6fa621961ac Mon Sep 17 00:00:00 2001 From: Samuel Lucas <63159663+samuel-lucas6@users.noreply.github.com> Date: Mon, 5 Jul 2021 12:35:51 +0100 Subject: [PATCH] README.md: Use Windows file paths. This is to be consistent since the GIF was taken on Windows and all of the examples should be using the same format. --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 87a14fd..9a007cd 100644 --- a/README.md +++ b/README.md @@ -60,10 +60,10 @@ 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: ``` @@ -71,12 +71,12 @@ $ 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 ```