Skip to content

Commit 05556ee

Browse files
📚 docs(README): Add code sample.
1 parent 1b64b4f commit 05556ee

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ See [docs](https://iterable-iterator.github.io/iter/index.html).
1111
> `regeneratorRuntime` to be defined, for instance by importing
1212
> [regenerator-runtime/runtime](https://www.npmjs.com/package/regenerator-runtime).
1313
14+
```js
15+
import {iter} from '@iterable-iterator/iter';
16+
iter('ABC').next().value; // A
17+
```
18+
1419
[![License](https://img.shields.io/github/license/iterable-iterator/iter.svg)](https://raw.githubusercontent.com/iterable-iterator/iter/main/LICENSE)
1520
[![Version](https://img.shields.io/npm/v/@iterable-iterator/iter.svg)](https://www.npmjs.org/package/@iterable-iterator/iter)
1621
[![Tests](https://img.shields.io/github/workflow/status/iterable-iterator/iter/ci:test?event=push&label=tests)](https://github.com/iterable-iterator/iter/actions/workflows/ci:test.yml?query=branch:main)

0 commit comments

Comments
 (0)