From 4a32c95f533986f74026ade5d160ed8165927634 Mon Sep 17 00:00:00 2001 From: mettjus Date: Fri, 13 May 2016 23:47:23 +0200 Subject: [PATCH] Improve command list in README Explicitly display for each command if it requires a target (a file or a key) or it doesn't. --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index c1c2f14..5142cb4 100644 --- a/README.md +++ b/README.md @@ -73,24 +73,24 @@ Installation Instructions: Commands: ========= -| Name: | Description: | -|------------------------------|-------------------------------------------------------------------------| -| `blackbox_edit` | Decrypt, run $EDITOR, re-encrypt a file | -| `blackbox_edit_start` | Decrypt a file so it can be updated | -| `blackbox_edit_end` | Encrypt a file after blackbox_edit_start was used | -| `blackbox_cat` | Decrypt and view the contents of a file | -| `blackbox_diff` | Diff decrypted files against their original crypted version | -| `blackbox_initialize` | Enable blackbox for a GIT or HG repo | -| `blackbox_register_new_file` | Encrypt a file for the first time | -| `blackbox_deregister_file` | Remove a file from blackbox | -| `blackbox_list_files` | List the files maintained by blackbox | -| `blackbox_decrypt_all_files` | Decrypt all managed files (INTERACTIVE) | -| `blackbox_postdeploy` | Decrypt all managed files (batch) | -| `blackbox_addadmin` | Add someone to the list of people that can encrypt/decrypt secrets | -| `blackbox_removeadmin` | Remove someone from the list of people that can encrypt/decrypt secrets | -| `blackbox_shred_all_files` | Safely delete any decrypted files | -| `blackbox_update_all_files` | Decrypt then re-encrypt all files. Useful after keys are changed | -| `blackbox_whatsnew` | show what has changed in the last commit for a given file | +| Name: | Description: | +|-------------------------------------|-------------------------------------------------------------------------| +| `blackbox_edit ` | Decrypt, run $EDITOR, re-encrypt a file | +| `blackbox_edit_start ` | Decrypt a file so it can be updated | +| `blackbox_edit_end ` | Encrypt a file after blackbox_edit_start was used | +| `blackbox_cat ` | Decrypt and view the contents of a file | +| `blackbox_diff` | Diff decrypted files against their original crypted version | +| `blackbox_initialize` | Enable blackbox for a GIT or HG repo | +| `blackbox_register_new_file ` | Encrypt a file for the first time | +| `blackbox_deregister_file ` | Remove a file from blackbox | +| `blackbox_list_files` | List the files maintained by blackbox | +| `blackbox_decrypt_all_files` | Decrypt all managed files (INTERACTIVE) | +| `blackbox_postdeploy` | Decrypt all managed files (batch) | +| `blackbox_addadmin ` | Add someone to the list of people that can encrypt/decrypt secrets | +| `blackbox_removeadmin ` | Remove someone from the list of people that can encrypt/decrypt secrets | +| `blackbox_shred_all_files` | Safely delete any decrypted files | +| `blackbox_update_all_files` | Decrypt then re-encrypt all files. Useful after keys are changed | +| `blackbox_whatsnew ` | show what has changed in the last commit for a given file | Compatibility: ==============