Skip to content

Commit 866eb54

Browse files
committed
Update README.md
1 parent 2a012c3 commit 866eb54

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,16 @@
22

33
A [Cycle.js](http://cycle.js.org) [Driver](http://cycle.js.org/drivers.html) for making HTTP requests, using the [Fetch API](https://fetch.spec.whatwg.org/).
44

5-
```
6-
npm install cycle-fetch-driver
7-
```
5+
## Install
86

9-
[![npm version](https://badge.fury.io/js/cycle-fetch-driver.svg)](http://badge.fury.io/js/cycle-fetch-driver)
7+
Only via git for now. I will publish this module on npm once I have a test suite. Pull requests welcome!
108

119
## Usage
1210

1311
Basics:
1412

1513
```js
14+
import 'whatwg-fetch' // polyfill if you want to support older browsers
1615
import Cycle from '@cycle/core';
1716
import { makeFetchDriver } from 'cycle-fetch-driver';
1817

@@ -75,3 +74,14 @@ function main(responses) {
7574
};
7675
}
7776
```
77+
78+
## Roadmap
79+
80+
### v0.x
81+
- Add tests
82+
- Support hash changes
83+
- Use cycle eslint config
84+
85+
### v1.x
86+
- Move to cycle.js org
87+
- Publish on npm

0 commit comments

Comments
 (0)