diff --git a/README.md b/README.md index fd41281..e87b65e 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ function takeBuffer() { This library is just a simple abstraction, that turns that into: ```js -let bufferedValue; +let bufferedValue = consumable(); // ... some code ... @@ -36,6 +36,8 @@ function takeBuffer() { } ``` +... with some extra internal checks in place to throw an error when a value is unexpectedly missing. + ## License, donations, and other boilerplate Licensed under either the [WTFPL](http://www.wtfpl.net/txt/copying/) or [CC0](https://creativecommons.org/publicdomain/zero/1.0/), at your choice. In practice, that means it's more or less public domain, and you can do whatever you want with it. Giving credit is *not* required, but still very much appreciated! I'd love to [hear from you](mailto:admin@cryto.net) if this module was useful to you.