Update docs

atgreen · Nov 27, 2023 · 45aee1e · 45aee1e
1 parent a82cd62
commit 45aee1e
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,8 @@
 # privacy-output-stream
-A Common Lisp output stream that masks secret strings
 
-`privacy-output-stream` is a character output stream that wraps other
-streams, like `*standard-output*` and masks secrets from the output by
-replacing them with a series of `*`.
+`privacy-output-stream` is a privacy preserving character output
+stream.  It wraps other streams, like `*standard-output*`, and masks
+secrets from the output by replacing them with a series of `*`.
 
 For example, the following code:
 ```
@@ -20,9 +19,10 @@ Hello, my password is ********
 
 ```secrets``` is a list of secret values you want to mask in the final
 output.  They are processed in order, so I recommend that you sort
-your secrets by length in case one is a substring of another.
+your secrets by length (longest first) in case one is a substring of
+another.
 
-Note also, that `privacy-output-stream` only masks secrets that are
+Note also that `privacy-output-stream` only masks secrets that are
 presented in full as part of a string or sequence being written to the
 stream.  Secrets written in fragments (by character or substring) will
 not be masked.