Skip to content

Commit 1672cd2

Browse files
committed
docs(readme): add emojis to main headers
1 parent 17f7539 commit 1672cd2

File tree

1 file changed

+23
-30
lines changed

1 file changed

+23
-30
lines changed

README.md

Lines changed: 23 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -16,33 +16,32 @@
1616

1717
<!-- toc -->
1818

19-
* [Introduction](#introduction)
20-
* [Installation](#installation)
21-
* [Everyday Usage](#everyday-usage)
19+
* [Introduction :wave:](#introduction-wave)
20+
* [Installation :cd:](#installation-cd)
21+
* [Everyday Usage :sunglasses:](#everyday-usage-sunglasses)
2222
+ [Creating global stores](#creating-global-stores)
2323
+ [Creating reactive views](#creating-reactive-views)
2424
+ [Creating local stores](#creating-local-stores)
25-
* [Advanced Usage](#advanced-usage)
25+
* [Advanced Usage :nerd_face:](#advanced-usage-nerd_face)
2626
+ [Adding side effects](#adding-side-effects)
27-
* [API Summary](#api-summary)
27+
* [API Summary :book:](#api-summary-book)
2828
+ [store(obj)](#storeobj)
2929
+ [view(Comp)](#viewcomp)
3030
+ [batch(fn)](#batchfn)
3131
+ [autoEffect(fn)](#autoeffectfn)
3232
+ [clearEffect(fn)](#cleareffectfn)
33-
* [Examples with live demos](#examples-with-live-demos)
34-
* [Articles](#articles)
35-
* [Performance](#performance)
36-
* [Platform support](#platform-support)
37-
* [Alternative builds](#alternative-builds)
38-
* [Contributing](#contributing)
39-
* [Contributors ✨](#contributors-%E2%9C%A8)
33+
* [Examples with live demos :tv:](#examples-with-live-demos-tv)
34+
* [Articles :loudspeaker:](#articles-loudspeaker)
35+
* [Performance :rocket:](#performance-rocket)
36+
* [Platform support :computer:](#platform-support-computer)
37+
* [Alternative builds :wrench:](#alternative-builds-wrench)
38+
* [Contributors :sparkles:](#contributors-sparkles)
4039

4140
<!-- tocstop -->
4241

4342
</details>
4443

45-
## Introduction
44+
## Introduction :wave:
4645

4746
React Easy State is a practical state management library with two functions and two accompanying rules.
4847

@@ -65,7 +64,7 @@ This is enough for it to automatically update your views when needed. It doesn't
6564

6665
Check this [TodoMVC codesandbox](https://codesandbox.io/s/github/RisingStack/react-easy-state/tree/master/examples/todo-mvc?module=%2Fsrc%2FtodosStore.js) or [raw code](/examples/todo-mvc/src/todosStore.js) for a more exciting example with nested data, arrays and computed values.
6766

68-
## Installation
67+
## Installation :cd:
6968

7069
`npm install @risingstack/react-easy-state`
7170

@@ -86,7 +85,7 @@ _You need npm 5.2+ to use npx._
8685

8786
</details>
8887

89-
## Everyday Usage
88+
## Everyday Usage :sunglasses:
9089

9190
### Creating global stores
9291

@@ -633,7 +632,7 @@ Instead of returning an object, you should directly mutate the received stores.
633632

634633
</details>
635634

636-
## Advanced Usage
635+
## Advanced Usage :nerd_face:
637636

638637
### Adding side effects
639638

@@ -734,9 +733,7 @@ class App extends Component {
734733
}
735734
```
736735

737-
---
738-
739-
## API Summary
736+
## API Summary :book:
740737

741738
### store(obj)
742739

@@ -808,9 +805,7 @@ const effect = autoEffect(() => document.title = user.name)
808805
clearEffect(effect)
809806
```
810807

811-
---
812-
813-
## Examples with live demos
808+
## Examples with live demos :tv:
814809

815810
#### Beginner
816811

@@ -824,20 +819,20 @@ clearEffect(effect)
824819
- [Contacts Table](https://risingstack.github.io/react-easy-state/examples/contacts/build) ([source](/examples/contacts/)) ([codesandbox](https://codesandbox.io/s/github/RisingStack/react-easy-state/tree/master/examples/contacts)): a data grid implementation with a mix of global and local state.
825820
- [Beer Finder](https://risingstack.github.io/react-easy-state/examples/beer-finder/build) ([source](/examples/beer-finder/)) ([codesandbox](https://codesandbox.io/s/github/RisingStack/react-easy-state/tree/master/examples/beer-finder)) ([tutorial](https://medium.com/@solkimicreb/design-patterns-with-react-easy-state-830b927acc7c)): an app with async actions and a mix of local and global state, which finds matching beers for your meal.
826821

827-
## Articles
822+
## Articles :loudspeaker:
828823

829824
- [Introducing React Easy State](https://blog.risingstack.com/introducing-react-easy-state/): making a simple stopwatch.
830825
- [Stress Testing React Easy State](https://medium.com/@solkimicreb/stress-testing-react-easy-state-ac321fa3becf): demonstrating Easy State's reactivity with increasingly exotic state mutations.
831826
- [Design Patterns with React Easy State](https://medium.com/@solkimicreb/design-patterns-with-react-easy-state-830b927acc7c): demonstrating async actions and local and global state management through a beer finder app.
832827
- [The Ideas Behind React Easy State](https://medium.com/dailyjs/the-ideas-behind-react-easy-state-901d70e4d03e): a deep dive under the hood of Easy State.
833828

834-
## Performance
829+
## Performance :rocket:
835830

836831
You can compare Easy State with plain React and other state management libraries with the below benchmarks. It performs a bit better than MobX and similarly to Redux.
837832

838833
- [js-framework-benchmark](https://github.com/krausest/js-framework-benchmark) ([source](https://github.com/krausest/js-framework-benchmark/tree/master/react-v16.1.0-easy-state-v4.0.1-keyed)) ([results](https://rawgit.com/krausest/js-framework-benchmark/master/webdriver-ts-results/table.html))
839834

840-
## Platform support
835+
## Platform support :computer:
841836

842837
- Node: 6 and above
843838
- Chrome: 49 and above
@@ -849,7 +844,7 @@ You can compare Easy State with plain React and other state management libraries
849844

850845
_This library is based on non polyfillable ES6 Proxies. Because of this, it will never support IE._
851846

852-
## Alternative builds
847+
## Alternative builds :wrench:
853848

854849
This library detects if you use ES6 or commonJS modules and serve the right format to you. The default bundles use ES6 features, which may not yet be supported by some minifier tools. If you experience issues during the build process, you can switch to one of the ES5 builds from below.
855850

@@ -860,11 +855,9 @@ This library detects if you use ES6 or commonJS modules and serve the right form
860855

861856
If you use a bundler, set up an alias for `@risingstack/react-easy-state` to point to your desired build. You can learn how to do it with webpack [here](https://webpack.js.org/configuration/resolve/#resolve-alias) and with rollup [here](https://github.com/rollup/rollup-plugin-alias#usage).
862857

863-
## Contributing
864-
865-
Contributions are always welcome. Please read our [contributing documentation](CONTRIBUTING.md). Thanks!
858+
## Contributors :sparkles:
866859

867-
## Contributors ✨
860+
Contributions are always welcome, please read our [contributing documentation](CONTRIBUTING.md).
868861

869862
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
870863

0 commit comments

Comments
 (0)