diff --git a/README.md b/README.md index d283460..e6a0f0a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,47 @@ # stoppable.js Utility library implementing tooling to make stoppable functions... + +```shell +$ npm install --save ig-stoppable +``` + +```javascript +var stoppable = require('ig-stoppable') +``` + + +```javascript +var func = stoppable(function(){ + // ... + + throw stoppable.STOP('something') + + // ... +}) + +var value = func() // -> 'something' +``` + +```javascript +var gen = stoppable(function*(){ + // ... + + throw stoppable.STOP('something') + + // ... +}) + +var value = [...gen()] // -> ['somthing'] +``` + +```javascript +var agen = stoppable(async function*(){ + // ... + + throw stoppable.STOP('something') + + // ... +}) + +var value = awat agen() // -> ['something'] +``` \ No newline at end of file