From 98260f8614a02df9735806b2d4140ab01a943da9 Mon Sep 17 00:00:00 2001 From: Brian Vaughn Date: Wed, 8 May 2019 12:53:22 -0700 Subject: [PATCH] Added installation instructions to README --- README.md | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4f4dc5a0ec..daa230d5ee 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,23 @@ -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. +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/). + +# Installation + +Installation instructions are available online as well: +* [Chrome](https://react-devtools-experimental-chrome.now.sh/) +* [Firefox](https://react-devtools-experimental-firefox.now.sh/). + +Or you can build and install from source: +```sh +git clone git@github.com:bvaughn/react-devtools-experimental.git + +cd react-devtools-experimental -To get started... -``` yarn install -yarn start + +yarn build:extension:chrome # builds at "shells/browser/chrome/build" +yarn build:extension:firefox # builds at "shells/browser/firefox/build" ``` -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 +# Support + +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