You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 6, 2025. It is now read-only.
* 📝 Add an section about interoperability
* 📝 Add an installation section
* 📝 Add a documention section
* 📝 Add usage section
* 📝 Add a contributing section
* 📝 Add a license section
* 📝 Add demo link
* 👌 Take care of reviews
Copy file name to clipboardexpand all lines: README.md
+66-2
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ immutad●t gives you a short and meaningful syntax to apply operations on immut
20
20
21
21
In the last few years one of our biggest challenge has been to find an efficient way to detect changes in our data to determine when to re-render our interfaces.
22
22
23
-
An immutable object is an object that cannot be changed once created. It brings several benefits<sup>[1](#notes)</sup>:
23
+
An immutable object is an object that cannot be changed once created. It brings several benefits<sup>[1](#notes)</sup>:
24
24
25
25
- Data changes detection made simple (Shallow comparison)
26
26
- Memoization
@@ -32,7 +32,11 @@ An immutable object is an object that cannot be changed once created. It brings
32
32
33
33
### Concise
34
34
35
-
[ES2015+](https://github.com/tc39/ecma262#ecmascript) new features are great to deal with arrays and objects. As data structures get deeper, the code you write to make data immutable gets bigger and less readable. immutad●t uses the dot notation to address this issue.
35
+
[ES2015+](https://github.com/tc39/ecma262#ecmascript) new features are great to deal with arrays and objects. As data structures expand, the code you write to make data immutable gets bigger and less readable. immutad●t uses the dot notation to address this issue.
36
+
37
+
### Interoperability
38
+
39
+
immutad●t uses plain JavaScript objects so you can access your data using standard ways. Moreover, it lets you freely enjoy your favorite libraries.
36
40
37
41
### Exhaustive and yet extensible
38
42
@@ -42,6 +46,66 @@ immutad●t comes with a large set of built-in utilities, mostly based on [lodas
42
46
43
47
If you are already familiar with [lodash](https://lodash.com/) and [ES2015+](https://github.com/tc39/ecma262#ecmascript) then you should be able to use immutad●t quickly.
44
48
49
+
## Installation
50
+
51
+
immutad●t is available on [npm repository](https://www.npmjs.com/package/immutadot).
52
+
53
+
using yarn:
54
+
55
+
```shell
56
+
$ yarn add immutadot
57
+
```
58
+
59
+
using npm:
60
+
61
+
```shell
62
+
$ npm install immutadot
63
+
```
64
+
65
+
or you can directly download [sources](https://github.com/Zenika/immutadot/releases).
Feel free to try immutad●t on [runkit](https://npm.runkit.com/immutadot).
88
+
89
+
## Documentation
90
+
91
+
The full list of immutad●t's features is available in our [documentation](https://zenika.github.io/immutadot).
92
+
93
+
## Contributing
94
+
95
+
We want contributing to immutad●t to be fun, enjoyable, and educational for anyone, and everyone.
96
+
97
+
### [Code of Conduct](https://github.com/Zenika/immutadot/blob/master/.github/CODE_OF_CONDUCT.md)
98
+
99
+
In the interest of fostering an open and welcoming environment, we have adopted a Code of Conduct that we expect project participants to commit to. Please read the [full text](https://github.com/Zenika/immutadot/blob/master/.github/CODE_OF_CONDUCT.md) so that you can understand what behavior will and will not be tolerated.
If you are interested in contributing to immutad●t, please read our [contributing guide](https://github.com/Zenika/immutadot/blob/master/.github/CONTRIBUTING.md) to learn more about how to suggest bugfixes and improvements.
104
+
105
+
## License
106
+
107
+
immutad●t is [MIT licensed](https://github.com/Zenika/immutadot/blob/master/LICENSE.md).
108
+
45
109
## Notes
46
110
47
111
-[1](#immutability): You can find more informations about immutability and its benefits in the following article http://reactkungfu.com/2015/08/pros-and-cons-of-using-immutability-with-react-js/
0 commit comments