yacd/README.md

# yacd

> Yet Another [Clash](https://github.com/Dreamacro/clash) Dashboard

Note for Firefox user:

**yacd** is using the [Fetch (Web) API][fetch-api] to stream chunked API response from Clash to draw the traffic chart. But currently the streaming feature in Firefox needs to be turned on manually. Here is how to:

Visit `about:config`, search for `dom.streams.enabled` and `javascript.options.streams`, double click those items to turn them on.

[fetch-api]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API

## Development

```sh
# install dependencies
yarn

# start the dev server
yarn start

# go to http://127.0.0.1:3000
```
doc: add simple readme 2018-10-20 20:34:35 +08:00			`# yacd`

doc: add link to Clash 2018-10-21 18:28:13 +08:00			`> Yet Another [Clash](https://github.com/Dreamacro/clash) Dashboard`
doc: add note for how to turn on fetch streaming in firfox 2018-10-21 16:01:50 +08:00
			`Note for Firefox user:`

			`yacd is using the [Fetch (Web) API][fetch-api] to stream chunked API response from Clash to draw the traffic chart. But currently the streaming feature in Firefox needs to be turned on manually. Here is how to:`

doc: add development section into readme 2018-10-21 18:25:50 +08:00			Visit `about:config`, search for `dom.streams.enabled` and `javascript.options.streams`, double click those items to turn them on.
doc: add note for how to turn on fetch streaming in firfox 2018-10-21 16:01:50 +08:00
			`[fetch-api]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API`
doc: add development section into readme 2018-10-21 18:25:50 +08:00
			`## Development`

			```sh
			`# install dependencies`
			`yarn`

			`# start the dev server`
			`yarn start`

			`# go to http://127.0.0.1:3000`
			```