8000 deploy: 80aa4c6c6ee03dce1dd2b7b686491e33994d463a · phocks/immutable-js@7f647fc · GitHub
[go: up one dir, main page]
Skip to content

Commit 7f647fc

Browse files
github-actions[bot]github-actions[bot]
committed
deploy: 80aa4c6 
1 parent c773d43 commit 7f647fc

File tree

1 file changed

+79
-19
lines changed

1 file changed

+79
-19
lines changed

‎README.md

Lines changed: 79 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,27 @@
22

33
[![Build Status](https://github.com/immutable-js/immutable-js/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/immutable-js/immutable-js/actions/workflows/ci.yml?query=branch%3Amain) [Chat on slack](https://immutable-js.slack.com)
44

5+
[Read the docs](https://immutable-js.com) and eat your vegetables.
6+
7+
Docs are automatically generated from [README.md][] and [immutable.d.ts][].
8+
Please contribute! Also, don't miss the [wiki][] which contains articles on
9+
additional specific topics. Can't find something? Open an [issue][].
10+
11+
**Table of contents:**
12+
13+
- [Introduction](#introduction)
14+
- [Getting started](#getting-started)
15+
- [The case for Immutability](#the-case-for-immutability)
16+
- [JavaScript-first API](#javaScript-first-api)
17+
- [Nested Structures](#nested-structures)
18+
- [Equality treats Collections as Values](#equality-treats-collections-as-values)
19+
- [Batching Mutations](#batching-mutations)
20+
- [Lazy Seq](#lazy-seq)
21+
- [Additional Tools and Resources](#additional-tools-and-resources)
22+
- [Contributing](#contributing)
23+
24+
## Introduction
25+
526
[Immutable][] data cannot be changed once created, leading to much simpler
627
application development, no defensive copying, and enabling advanced memoization
728
and change detection techniques with simple logic. [Persistent][] data presents
@@ -23,6 +44,10 @@ Want to hear more? Watch the presentation about Immutable.js:
2344

2445
[![Immutable Data and React](website/public/Immutable-Data-and-React-YouTube.png)](https://youtu.be/I7IdS-PbEgI)
2546

47+
[README.md]: https://github.com/immutable-js/immutable-js/blob/main/README.md
48+
[immutable.d.ts]: https://github.com/immutable-js/immutable-js/blob/main/type-definitions/immutable.d.ts
49+
[wiki]: https://github.com/immutable-js/immutable-js/wiki
50+
[issue]: https://github.com/immutable-js/immutable-js/issues
2651
[Persistent]: https://en.wikipedia.org/wiki/Persistent_data_structure
2752
[Immutable]: https://en.wikipedia.org/wiki/Immutable_object
2853
[hash maps tries]: https://en.wikipedia.org/wiki/Hash_array_mapped_trie
@@ -612,46 +637,81 @@ Range(1, Infinity)
612637
// 1006008
613638
```
614639

615-
## Documentation
640+
## Additional Tools and Resources
616641

617-
## Documentation
642+
- [Atom-store](https://github.com/jameshopkins/atom-store/)
643+
- A Clojure-inspired atom implementation in Javascript with configurability
644+
for external persistance.
618645

619-
[Read the docs](https://immutable-js.com) and eat your vegetables.
646+
- [Chai Immutable](https://github.com/astorije/chai-immutable)
647+
- If you are using the [Chai Assertion Library](https://chaijs.com/), this
648+
provides a set of assertions to use against Immutable.js collections.
649+
650+
- [Fantasy-land](https://github.com/fantasyland/fantasy-land)
651+
- Specification for interoperability of common algebraic structures in JavaScript.
652+
653+
- [Immutagen](https://github.com/pelotom/immutagen)
654+
- A library for simulating immutable generators in JavaScript.
655+
656+
- [Immutable-cursor](https://github.com/redbadger/immutable-cursor)
657+
- Immutable cursors incorporating the Immutable.js interface over
658+
Clojure-inspired atom.
659+
660+
- [Immutable-ext](https://github.com/DrBoolean/immutable-ext)
661+
- Fantasyland extensions for immutablejs
662+
663+
- [Immutable-js-tools](https://github.com/madeinfree/immutable-js-tools)
664+
- Util tools for immutable.js
620665

621-
Docs are automatically generated from [immutable.d.ts](https://github.com/immutable-js/immutable-js/blob/main/type-definitions/immutable.d.ts).
622-
Please contribute!
666+
- [Immutable-Redux](https://github.com/gajus/redux-immutable)
667+
- redux-immutable is used to create an equivalent function of Redux
668+
combineReducers that works with Immutable.js state.
623669

624-
Also, don't miss the [Wiki](https://github.com/immutable-js/immutable-js/wiki) which
625-
contains articles on specific topics. Can't find something? Open an [issue](https://github.com/immutable-js/immutable-js/issues).
670+
- [Immutable-Treeutils](https://github.com/lukasbuenger/immutable-treeutils)
671+
- Functional tree traversal helpers for ImmutableJS data structures.
626672

627-
## Testing
673+
- [Irecord](https://github.com/ericelliott/irecord)
674+
- An immutable store that exposes an RxJS observable. Great for React.
628675

629-
If you are using the [Chai Assertion Library](https://chaijs.com/), [Chai Immutable](https://github.com/astorije/chai-immutable) provides a set of assertions to use against Immutable.js collections.
676+
- [Mudash](https://github.com/brianneisler/mudash)
677+
- Lodash wrapper providing Immutable.JS support.
630678

631-
## Contribution
679+
- [React-Immutable-PropTypes](https://github.com/HurricaneJames/react-immutable-proptypes)
680+
- PropType validators that work with Immutable.js.
632681

633-
## Contribution
682+
- [Redux-Immutablejs](https://github.com/indexiatech/redux-immutablejs)
683+
- Redux Immutable facilities.
684+
685+
- [Rxstate](https://github.com/yamalight/rxstate)
686+
- Simple opinionated state management library based on RxJS and Immutable.js.
687+
688+
- [Transit-Immutable-js](https://github.com/glenjamin/transit-immutable-js)
689+
- Transit serialisation for Immutable.js.
690+
- See also: [Transit-js](https://github.com/cognitect/transit-js)
691+
692+
Have an additional tool designed to work with Immutable.js?
693+
Submit a PR to add it to this list in alphabetical order.
694+
695+
## Contributing
634696

635697
Use [Github issues](https://github.com/immutable-js/immutable-js/issues) for requests.
636698

637699
We actively welcome pull requests, learn how to [contribute](https://github.com/immutable-js/immutable-js/blob/main/.github/CONTRIBUTING.md).
638700

639701
Immutable.js is maintained within the [Contributor Covenant's Code of Conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/).
640702

641-
We actively welcome pull requests, learn how to [contribute](https://github.com/immutable-js/immutable-js/blob/main/.github/CONTRIBUTING.md).
642-
643-
## Changelog
703+
### Changelog
644704

645705
Changes are tracked as [Github releases](https://github.com/immutable-js/immutable-js/releases).
646706

647-
## Thanks
707+
### License
708+
709+
Immutable.js is [MIT-licensed](./LICENSE).
710+
711+
### Thanks
648712

649713
[Phil Bagwell](https://www.youtube.com/watch?v=K2NYwP90bNs), for his inspiration
650714
and research in persistent data structures.
651715

652716
[Hugh Jackson](https://github.com/hughfdjackson/), for providing the npm package
653717
name. If you're looking for his unsupported package, see [this repository](https://github.com/hughfdjackson/immutable).
654-
655-
## License
656-
657-
Immutable.js is [MIT-licensed](./LICENSE).

0 commit comments

Comments
 (0)
0