Add documentation and changelog

master
Sven Slootweg 8 years ago
parent fc6593ec93
commit 14e0ba51d6

@ -0,0 +1,9 @@
## 1.0.0 (August 16, 2016)
First stable and documented release - however, the functionality or API has not changed from `0.0.1`.
* __Documentation:__ Added documentation and a changelog.
## 0.0.1 (April 17, 2016)
Initial release.

@ -2,15 +2,17 @@
Wraps a value in an array if it isn't already one. Returns an empty array for `null` and `undefined`.
A typical usecase for this: when you have an option that accepts multiple values as an array, but you want to make the use of an array literal optional when there's only a single value to specify.
## License
[WTFPL](http://www.wtfpl.net/txt/copying/) or [CC0](https://creativecommons.org/publicdomain/zero/1.0/), whichever you prefer. A donation and/or attribution are appreciated, but not required.
## Donate
My income consists largely of donations for my projects. If this module is useful to you, consider [making a donation](http://cryto.net/~joepie91/donate.html)!
Maintaining open-source projects takes a lot of time, and the more donations I receive, the more time I can dedicate to open-source. If this module is useful to you, consider [making a donation](http://cryto.net/~joepie91/donate.html)!
You can donate using Bitcoin, PayPal, Flattr, cash-in-mail, SEPA transfers, and pretty much anything else.
You can donate using Bitcoin, PayPal, Flattr, cash-in-mail, SEPA transfers, and pretty much anything else. Thank you!
## Contributing
@ -22,8 +24,23 @@ Be aware that by making a pull request, you agree to release your modifications
## Usage
TODO
Some examples:
```javascript
var assureArray = require("assure-array");
assureArray("hello world"); // ["hello world!"]
assureArray(["hello", "world"]); // ["hello", "world"]
assureArray(null); // []
assureArray([true]); // [true]
```
## API
TODO
### assureArray(value)
Ensures that the provided `value` is returned as an array.
* If `value` is an array already, this returns the array unchanged.
* If `value` is `null` or `undefined`, this returns an empty array.
* If `value` is any other kind of value, this returns a new array containing just that one value.
Loading…
Cancel
Save