Add some notes to the readme

marshallpierce · Jul 28, 2019 · c1fcfcb · c1fcfcb
1 parent 15ed64d
commit c1fcfcb
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -9,6 +9,8 @@ Made with CLion. Thanks to JetBrains for supporting open source!
 
 It's base64. What more could anyone want?
 
+This library's goals are to be *correct* and *fast*. It's thoroughly tested and widely used. It exposes functionality at multiple levels of abstraction so you can choose the level of convenience vs performance that you want, e.g. `decode_config_slice` decodes into an existing `&mut [u8]` and is pretty fast (2.6GiB/s for a 3 KiB input), whereas `decode_config` allocates a new `Vec<u8>` and returns it, which might be more convenient in some cases, but is slower (although still fast enough for most purposes) at 2.1 GiB/s.
+
 Example
 ---