xmengnet/yacd
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

doc: add development section into readme

Browse source
This commit is contained in:
Haishan 2018-10-21 18:25:50 +08:00
parent ca5d887fd8
commit 7e0245a636
1 changed files with 13 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -6,6 +6,18 @@ 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: **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 item to turn them on. 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 [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
```