From 7e0245a636d3755fdfc4eb2b74eba069c3c44d30 Mon Sep 17 00:00:00 2001 From: Haishan Date: Sun, 21 Oct 2018 18:25:50 +0800 Subject: [PATCH] doc: add development section into readme --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 58b989c..494824a 100644 --- a/README.md +++ b/README.md @@ -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: -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 + +## Development + +```sh +# install dependencies +yarn + +# start the dev server +yarn start + +# go to http://127.0.0.1:3000 +```