From 2b1d25ff3948ca5577d62662a36bf55a9772d096 Mon Sep 17 00:00:00 2001 From: Dan Abramov Date: Wed, 15 Jul 2015 00:45:02 +0300 Subject: [PATCH] 0.1.0 README --- README.md | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0ac15a08..d8598f0b 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,17 @@ Redux DevTools ========================= -Haha. README coming. Also not on NPM yet. +A better README is coming. But if you insist... + +### Installation + +It's out on NPM as `react-devtools@0.1.0`. + +[This commit](https://github.com/gaearon/redux-devtools/commit/0a2a97556e252bfad822ca438923774bc8b932a4) should give you an idea about how to add Redux DevTools for your app **but make sure to only apply `devTools()` in development!** In production, this will be terribly slow because actions just accumulate forever. (We'll need to implement a rolling window for dev too.) ### Running Examples -In the meantime, you can do this: +You can do this: ``` git clone https://github.com/gaearon/redux-devtools.git @@ -21,10 +27,21 @@ open http://localhost:3000 Try clicking on actions in the log, or changing some code inside `examples/counter/reducers/counter`. For fun, you can also open `http://localhost:3000/?debug_session=123`, click around, and then refresh. -Oh, and you can do this with the TodoMVC example as well. +Oh, and you can do the same with the TodoMVC example as well. ### It's Ugly! The design or usability is not the point. (Although we'll have better design in the future :-) -You can build a completely custom UI for it because `` accepts a `monitor` React component prop. You can build any UI you want for it. The included `LogMonitor` is just an example. +**You can build a completely custom UI for it because `` accepts a `monitor` React component prop.** The included `LogMonitor` is just an example. + +Some crazy ideas for custom monitors: + +* A slider that lets you jump between computed states just by dragging it +* An in-app layer that shows the last N states right in the app (e.g. for animation) +* A time machine like interface where the last N states of your app reside on different Z layers +* Feel free to come up with and implement your own! Check `LogMonitor` propTypes to see what you can do. + +### License + +MIT