Added installation instructions to README
Brian Vaughn committed
May 8, 2019 at 12:53 UTC
98260f8614a02df9735806b2d4140ab01a943da9
1 file changed
+19
-5
README.md
+19
-5
@@ -1,9 +1,23 @@
1
-This is an **experimental rewrite** of the React DevTools extension (see [github.com/facebook/react-devtools](https://github.com/facebook/react-devtools)). This project is **not supported** and has only been posted as a way of sharing ideas with others who may be interested.
1
+This repo is a work-in-progress rewrite of the [React DevTools extension](https://github.com/facebook/react-devtools). A demo of the beta extension can be found online at [react-devtools-experimental.now.sh](https://react-devtools-experimental.now.sh/).
2
+
3
+# Installation
4
+
5
+Installation instructions are available online as well:
6
+* [Chrome](https://react-devtools-experimental-chrome.now.sh/)
7
+* [Firefox](https://react-devtools-experimental-firefox.now.sh/).
8
+
9
+Or you can build and install from source:
10
+```sh
11
+git clone git@github.com:bvaughn/react-devtools-experimental.git
12
+
13
+cd react-devtools-experimental
14
3
-To get started...
4
-```
15
yarn install
6
-yarn start
16
+
17
+yarn build:extension:chrome # builds at "shells/browser/chrome/build"
18
+yarn build:extension:firefox # builds at "shells/browser/firefox/build"
19
```
20
9
-A preview build of this rewrite is available at [react-devtools-experimental.now.sh](https://react-devtools-experimental.now.sh/).
\ No newline at end of file
21
+# Support
22
+
23
+As this extension is in a beta period, it is not officially supported. However if you find a bug, we'd appreciate you reporting it as a [GitHub issue](https://github.com/bvaughn/react-devtools-experimental/issues/new) with repro instructions.
\ No newline at end of file