aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Mueller <deso@posteo.net>2018-12-27 20:46:13 -0800
committerDaniel Mueller <deso@posteo.net>2018-12-27 20:46:13 -0800
commit0148d954b1ea3105696e9958152b679997d9be86 (patch)
tree93bd2ad2787a547193f065a3f94b790f32ea3fd8
parenta41c822bf1329c73cba527b15f30f0c2479904f5 (diff)
downloadnitrocli-0148d954b1ea3105696e9958152b679997d9be86.tar.gz
nitrocli-0148d954b1ea3105696e9958152b679997d9be86.tar.bz2
Update README to reflect changes in output of the status command
With recent refactorings the output of the status command changed slightly. With this patch we update the README that happens to provide an example of said output in accordance with this change.
-rw-r--r--nitrocli/README.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/nitrocli/README.md b/nitrocli/README.md
index 8803e30..3e0b518 100644
--- a/nitrocli/README.md
+++ b/nitrocli/README.md
@@ -34,19 +34,23 @@ Usage
-----
Usage is as simple as providing the name of the respective command as a
-parameter, e.g.:
+parameter (note that some commands are organized through subcommands,
+which are required as well), e.g.:
```bash
# Open the nitrokey's encrypted volume.
$ nitrocli open
$ nitrocli status
Status:
- SD card ID: 0xdeadbeef
+ model: Storage
+ serial number: 0x00053141
firmware version: 0.47
- firmware: unlocked
- storage keys: created
user retry count: 3
admin retry count: 3
+
+ SD card ID: 0x05dcad1d
+ firmware: unlocked
+ storage keys: created
volumes:
unencrypted: active
encrypted: active