From 01800409fdacb9088badd337b029b21cd392bb37 Mon Sep 17 00:00:00 2001 From: Wes Bos Date: Fri, 22 Jan 2016 14:33:45 -0500 Subject: [PATCH] Added docs on Reset / Revert / Sweep / Commit buttons I didn't understand what these buttons did until I played around with them for a few minutes - I thought some nice documentation on what they do would be needed. --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 33591a8a..2e27fbda 100644 --- a/README.md +++ b/README.md @@ -412,6 +412,16 @@ Try clicking on actions in the log, or changing some code inside the reducers. Y Also try opening `http://localhost:3000/?debug_session=123`, click around, and then refresh. You should see that all actions have been restored from the local storage. +### What do the Reset / Revert / Sweep / Commit buttons do? + +**Sweep** will remove any disabled actions from your log. + +**Commit** works similar to a a git commit - it will remove all actions from your log and make the current state your initial state. + +**Revert** will remove any actions since your last commit. + +**Reset** will remove all actions and bring your store back to it's initial state. This includes actions that have previously been committed. + ### Custom Monitors **DevTools accepts monitor components so you can build a completely custom UI.** [`LogMonitor`](https://github.com/gaearon/redux-devtools-log-monitor) and [`DockMonitor`](https://github.com/gaearon/redux-devtools-dock-monitor) are just examples of what is possible.