Skip to content
This repository was archived by the owner on Jan 6, 2025. It is now read-only.

Commit 0a7bd1f

Browse files
authored
📝 Improve README
* 📝 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
1 parent f2d368b commit 0a7bd1f

File tree

1 file changed

+66
-2
lines changed

1 file changed

+66
-2
lines changed

README.md

+66-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ immutad●t gives you a short and meaningful syntax to apply operations on immut
2020

2121
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.
2222

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>:
2424

2525
- Data changes detection made simple (Shallow comparison)
2626
- Memoization
@@ -32,7 +32,11 @@ An immutable object is an object that cannot be changed once created. It brings
3232

3333
### Concise
3434

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.
3640

3741
### Exhaustive and yet extensible
3842

@@ -42,6 +46,66 @@ immutad●t comes with a large set of built-in utilities, mostly based on [lodas
4246

4347
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.
4448

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).
66+
67+
## Usage
68+
69+
in browser:
70+
71+
```js
72+
import { push } from 'immutadot'
73+
74+
push({ nested: { prop: [1, 2] } }, 'nested.prop', 3, 4)
75+
// → { nested: { prop: [1, 2, 3, 4] } }
76+
```
77+
78+
in node:
79+
80+
```js
81+
const { push } = require('immutadot')
82+
83+
push({ nested: { prop: [1, 2] } }, 'nested.prop', 3, 4)
84+
// → { nested: { prop: [1, 2, 3, 4] } }
85+
```
86+
87+
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.
100+
101+
### [Contributing guide](https://github.com/Zenika/immutadot/blob/master/.github/CONTRIBUTING.md)
102+
103+
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+
45109
## Notes
46110

47111
- [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

Comments
 (0)