joepie91/consumable
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Docs fix

Browse source
This commit is contained in:
Sven Slootweg 2020-07-19 00:34:42 +02:00
parent b0657521fe
commit 9b1d2ec22c
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -23,7 +23,7 @@ function takeBuffer() {
This library is just a simple abstraction, that turns that into: This library is just a simple abstraction, that turns that into:
```js ```js
let bufferedValue; let bufferedValue = consumable();
// ... some code ... // ... 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 ## 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. 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.