diff --git a/README.md b/README.md index 8388d4dc76..769af09793 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# +# Redux Logo Redux is a predictable state container for JavaScript apps. (Not to be confused with a WordPress framework – [Redux Framework](https://reduxframework.com/).) @@ -19,7 +19,7 @@ It is tiny (2kB, including dependencies). >**[Part 1: Getting Started with Redux](https://egghead.io/series/getting-started-with-redux) (30 free videos)**
>**[Part 2: Building React Applications with Idiomatic Redux](https://egghead.io/courses/building-react-applications-with-idiomatic-redux) (27 free videos)** -### Testimonials +## Testimonials >[“Love what you're doing with Redux”](https://twitter.com/jingc/status/616608251463909376) >Jing Chen, creator of Flux @@ -30,21 +30,21 @@ It is tiny (2kB, including dependencies). >[“It's cool that you are inventing a better Flux by not doing Flux at all.”](https://twitter.com/andrestaltz/status/616271392930201604) >André Staltz, creator of Cycle -### Before Proceeding Further +## Before Proceeding Further >**Also read:** >**[You Might Not Need Redux](https://medium.com/@dan_abramov/you-might-not-need-redux-be46360cf367)** -### Developer Experience +## Developer Experience I wrote Redux while working on my React Europe talk called [“Hot Reloading with Time Travel”](https://www.youtube.com/watch?v=xsSnOQynTHs). My goal was to create a state management library with minimal API but completely predictable behavior, so it is possible to implement logging, hot reloading, time travel, universal apps, record and replay, without any buy-in from the developer. -### Influences +## Influences Redux evolves the ideas of [Flux](http://facebook.github.io/flux/), but avoids its complexity by taking cues from [Elm](https://github.com/evancz/elm-architecture-tutorial/). Whether you have used them or not, Redux only takes a few minutes to get started with. -### Installation +## Installation To install the stable version: @@ -62,7 +62,7 @@ If you don't use a module bundler, it's also fine. The `redux` npm package inclu The Redux source code is written in ES2015 but we precompile both CommonJS and UMD builds to ES5 so they work in [any modern browser](http://caniuse.com/#feat=es5). You don't need to use Babel or a module bundler to [get started with Redux](https://github.com/reactjs/redux/blob/master/examples/counter-vanilla/index.html). -#### Complementary Packages +### Complementary Packages Most likely, you'll also need [the React bindings](https://github.com/reactjs/react-redux) and [the developer tools](https://github.com/gaearon/redux-devtools). @@ -73,7 +73,7 @@ npm install --save-dev redux-devtools Note that unlike Redux itself, many packages in the Redux ecosystem don't provide UMD builds, so we recommend using CommonJS module bundlers like [Webpack](https://webpack.js.org/) and [Browserify](http://browserify.org/) for the most comfortable development experience. -### The Gist +## The Gist The whole state of your app is stored in an object tree inside a single *store*. The only way to change the state tree is to emit an *action*, an object describing what happened. @@ -135,7 +135,7 @@ If you're coming from Flux, there is a single important difference you need to u This architecture might seem like an overkill for a counter app, but the beauty of this pattern is how well it scales to large and complex apps. It also enables very powerful developer tools, because it is possible to trace every mutation to the action that caused it. You can record user sessions and reproduce them just by replaying every action. -### Learn Redux from Its Creator +## Learn Redux from Its Creator [Getting Started with Redux](https://egghead.io/series/getting-started-with-redux) is a video course consisting of 30 videos narrated by Dan Abramov, author of Redux. It is designed to complement the “Basics” part of the docs while bringing additional insights about immutability, testing, Redux best practices, and using Redux with React. **This course is free and will always be.** @@ -156,11 +156,11 @@ This architecture might seem like an overkill for a counter app, but the beauty So, what are you waiting for? -#### [Watch the 30 Free Videos!](https://egghead.io/series/getting-started-with-redux) +### [Watch the 30 Free Videos!](https://egghead.io/series/getting-started-with-redux) If you enjoyed my course, consider supporting Egghead by [buying a subscription](https://egghead.io/pricing). Subscribers have access to the source code of every example in my videos and tons of advanced lessons on other topics, including JavaScript in depth, React, Angular, and more. Many [Egghead instructors](https://egghead.io/instructors) are also open source library authors, so buying a subscription is a nice way to thank them for the work that they've done. -### Documentation +## Documentation * [Introduction](http://redux.js.org/docs/introduction/index.html) * [Basics](http://redux.js.org/docs/basics/index.html) @@ -175,7 +175,7 @@ For PDF, ePub, and MOBI exports for offline reading, and instructions on how to For Offline docs, please see: [devdocs](http://devdocs.io/redux/) -### Examples +## Examples Almost all examples have a corresponding CodeSandbox sandbox. This is an interactive version of the code that you can play with online. @@ -192,11 +192,11 @@ Almost all examples have a corresponding CodeSandbox sandbox. This is an interac If you're new to the NPM ecosystem and have troubles getting a project up and running, or aren't sure where to paste the gist above, check out [simplest-redux-example](https://github.com/jackielii/simplest-redux-example) that uses Redux together with React and Browserify. -### Discussion +## Discussion Join the [#redux](https://discord.gg/0ZcbPKXt5bZ6au5t) channel of the [Reactiflux](http://www.reactiflux.com) Discord community. -### Thanks +## Thanks * [The Elm Architecture](https://github.com/evancz/elm-architecture-tutorial) for a great intro to modeling state updates with reducers; * [Turning the database inside-out](http://www.confluent.io/blog/turning-the-database-inside-out-with-apache-samza/) for blowing my mind; @@ -211,16 +211,16 @@ Join the [#redux](https://discord.gg/0ZcbPKXt5bZ6au5t) channel of the [Reactiflu Special thanks to [Jamie Paton](http://jdpaton.github.io) for handing over the `redux` NPM package name. -### Logo +## Logo You can find the official logo [on GitHub](https://github.com/reactjs/redux/tree/master/logo). -### Change Log +## Change Log This project adheres to [Semantic Versioning](http://semver.org/). Every release, along with the migration instructions, is documented on the Github [Releases](https://github.com/reactjs/redux/releases) page. -### Patrons +## Patrons The work on Redux was [funded by the community](https://www.patreon.com/reactdx). Meet some of the outstanding companies that made it possible: @@ -230,6 +230,6 @@ Meet some of the outstanding companies that made it possible: [See the full list of Redux patrons](PATRONS.md), as well as the always-growing list of [people and companies that use Redux](https://github.com/reactjs/redux/issues/310). -### License +## License MIT diff --git a/build/gitbook.css b/build/gitbook.css index 1cad5eb131..66d95844d6 100644 --- a/build/gitbook.css +++ b/build/gitbook.css @@ -4,7 +4,7 @@ } .book-summary ul.summary li a:hover { - color: #008cff; + color: #0070CC; text-decoration: none; } @@ -14,7 +14,7 @@ pre[class*="language-"] { } .color-theme-2 .token.keyword { - color: #3ac; + color: #24788F; } .token.operator {