adding use case blurb to readme

2018-03-12 20:16:59 -07:00 · 2018-03-12 20:16:59 -07:00 · d37214a847
parent b9febd88b9
commit d37214a847
1 changed files with 5 additions and 0 deletions
--- a/README.rst
+++ b/README.rst
@ -25,6 +25,11 @@ streams. What we really wanted was a standard stream that applies base64 encodin

 This led us to build :class:`base64io.Base64IO`.

+:class:`base64io.Base64IO` provides an `io` stream interface with context manager support
+that transparently performs base64 transormations to data passed through it. This can be
+very useful if you want to transform large files without caching the entire contenxt in memory
+or if you want to work with an existing stream and apply a base64 transformation to it.
+
 The latest full documentation can be found at `Read the Docs`_.

 Find us on `GitHub`_.