Skip to content

Commit 06c8ec9

Browse files
author
Arvid Nicolaas
committed
docs: update README files
1 parent c17415c commit 06c8ec9

File tree

45 files changed

+1589
-1285
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+1589
-1285
lines changed

‎README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22
<img src="https://github.com/rimbu-org/rimbu/raw/main/assets/rimbu_logo.svg" />
33
</p>
44

5-
[![npm version](https://badge.fury.io/js/@rimbu%2Fcore.svg)](https://www.npmjs.com/package/@rimbu/core) [![Deno](https://shield.deno.dev/x/rimbu)](http://deno.land/x/rimbu)
6-
![Licence](https://img.shields.io/github/license/rimbu-org/rimbu) [![codecov](https://codecov.io/gh/rimbu-org/rimbu/branch/main/graph/badge.svg?token=RSFK5B0N0Z)](https://codecov.io/gh/rimbu-org/rimbu)
5+
[![npm version](https://badge.fury.io/js/@rimbu%2Fcore.svg)](https://www.npmjs.com/package/@rimbu/core)
6+
[![Deno](https://shield.deno.dev/x/rimbu)](http://deno.land/x/rimbu)
7+
![Licence](https://img.shields.io/github/license/rimbu-org/rimbu)
8+
[![codecov](https://codecov.io/gh/rimbu-org/rimbu/branch/main/graph/badge.svg?token=RSFK5B0N0Z)](https://codecov.io/gh/rimbu-org/rimbu)
79

810
# Rimbu: Immutable Collections and Tools for TypeScript
911

‎deno_dist/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22
<img src="https://github.com/rimbu-org/rimbu/raw/main/assets/rimbu_logo.svg" />
33
</p>
44

5-
[![npm version](https://badge.fury.io/js/@rimbu%2Fcore.svg)](https://www.npmjs.com/package/@rimbu/core) [![Deno](https://shield.deno.dev/x/rimbu)](http://deno.land/x/rimbu)
6-
![Licence](https://img.shields.io/github/license/rimbu-org/rimbu) [![codecov](https://codecov.io/gh/rimbu-org/rimbu/branch/main/graph/badge.svg?token=RSFK5B0N0Z)](https://codecov.io/gh/rimbu-org/rimbu)
5+
[![npm version](https://badge.fury.io/js/@rimbu%2Fcore.svg)](https://www.npmjs.com/package/@rimbu/core)
6+
[![Deno](https://shield.deno.dev/x/rimbu)](http://deno.land/x/rimbu)
7+
![Licence](https://img.shields.io/github/license/rimbu-org/rimbu)
8+
[![codecov](https://codecov.io/gh/rimbu-org/rimbu/branch/main/graph/badge.svg?token=RSFK5B0N0Z)](https://codecov.io/gh/rimbu-org/rimbu)
79

810
# Rimbu: Immutable Collections and Tools for TypeScript
911

‎deno_dist/actor/README.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,30 +18,34 @@ For complete documentation please visit the _[Rimbu Docs](https://rimbu.org)_ or
1818

1919
### Compabitity
2020

21-
- [`Node >= 16` ![NodeJS](https://img.shields.io/badge/node.js-6DA55F?logo=node.js&logoColor=white)](https://nodejs.org)
21+
- [`Node` ![NodeJS](https://img.shields.io/badge/node.js-6DA55F?logo=node.js&logoColor=white)](https://nodejs.org)
2222
- [`Deno` ![Deno JS](https://img.shields.io/badge/deno%20js-000000?logo=deno&logoColor=white)](https://deno.com/runtime)
23-
- [`Bun >= 0.6.0` ![Bun](https://img.shields.io/badge/Bun-%23000000.svg?logoColor=white)](https://bun.sh/)
23+
- [`Bun` ![Bun](https://img.shields.io/badge/Bun-%23000000.svg?logoColor=white)](https://bun.sh/)
2424
- `Web` ![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?logoColor=white)
2525

26-
### Yarn / NPM / Bun
26+
### Package Managers
2727

28-
For `yarn`:
28+
**Yarn:**
2929

30-
> `yarn add @rimbu/actor`
31-
32-
For `npm`:
30+
```sh
31+
yarn add @rimbu/actor
32+
```
3333

34-
> `npm i @rimbu/actor`
34+
**npm:**
3535

36-
For `bun`:
36+
```sh
37+
npm install @rimbu/actor
38+
```
3739

38-
> `bun add @rimbu/actor`
40+
**Bun:**
3941

40-
### Deno
42+
```sh
43+
bun add @rimbu/actor
44+
```
4145

42-
For Deno, the following approach is recommended:
46+
### Deno Setup
4347

44-
In the root folder of your project, create or edit a file called `import_map.json` with the following contents (where you should replace `x.y.z` with the desired version of Rimbu):
48+
Create or edit `import_map.json` in your project root:
4549

4650
```json
4751
{
@@ -51,7 +55,7 @@ In the root folder of your project, create or edit a file called `import_map.jso
5155
}
5256
```
5357

54-
**Note: The trailing slashes are important!**
58+
_Replace `x.y.z` with the desired version._
5559

5660
In this way you can use relative imports from Rimbu in your code, like so:
5761

@@ -97,20 +101,18 @@ console.log(actor.state)
97101

98102
## Author
99103

100-
[Arvid Nicolaas](https://github.com/vitoke)
104+
Created and maintained by [Arvid Nicolaas](https://github.com/vitoke).
101105

102106
## Contributing
103107

104-
Feel very welcome to contribute to further improve Rimbu. Please read our [Contributing guide](https://github.com/rimbu-org/rimbu/blob/main/CONTRIBUTING.md).
108+
We welcome contributions! Please read our [Contributing guide](https://github.com/rimbu-org/rimbu/blob/main/CONTRIBUTING.md).
105109

106110
## Contributors
107111

108112
<img src = "https://contrib.rocks/image?repo=rimbu-org/rimbu"/>
109113

110-
Made with [contributors-img](https://contrib.rocks).
114+
_Made with [contributors-img](https://contrib.rocks)._
111115

112116
## License
113117

114-
Licensed under the MIT License, Copyright © 2020-present Arvid Nicolaas.
115-
116-
See [LICENSE](./LICENSE) for more information.
118+
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) for details.

‎deno_dist/base/README.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,30 +18,34 @@ For complete documentation please visit the _[Rimbu Docs](https://rimbu.org)_ or
1818

1919
### Compabitity
2020

21-
- [`Node >= 16` ![NodeJS](https://img.shields.io/badge/node.js-6DA55F?logo=node.js&logoColor=white)](https://nodejs.org)
21+
- [`Node` ![NodeJS](https://img.shields.io/badge/node.js-6DA55F?logo=node.js&logoColor=white)](https://nodejs.org)
2222
- [`Deno` ![Deno JS](https://img.shields.io/badge/deno%20js-000000?logo=deno&logoColor=white)](https://deno.com/runtime)
23-
- [`Bun >= 0.6.0` ![Bun](https://img.shields.io/badge/Bun-%23000000.svg?logoColor=white)](https://bun.sh/)
23+
- [`Bun` ![Bun](https://img.shields.io/badge/Bun-%23000000.svg?logoColor=white)](https://bun.sh/)
2424
- `Web` ![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?logoColor=white)
2525

26-
### Yarn / NPM / Bun
26+
### Package Managers
2727

28-
For `yarn`:
28+
**Yarn:**
2929

30-
> `yarn add @rimbu/base`
31-
32-
For `npm`:
30+
```sh
31+
yarn add @rimbu/base
32+
```
3333

34-
> `npm i @rimbu/base`
34+
**npm:**
3535

36-
For `bun`:
36+
```sh
37+
npm install @rimbu/base
38+
```
3739

38-
> `bun add @rimbu/base`
40+
**Bun:**
3941

40-
### Deno
42+
```sh
43+
bun add @rimbu/base
44+
```
4145

42-
For Deno, the following approach is recommended:
46+
### Deno Setup
4347

44-
In the root folder of your project, create or edit a file called `import_map.json` with the following contents (where you should replace `x.y.z` with the desired version of Rimbu):
48+
Create or edit `import_map.json` in your project root:
4549

4650
```json
4751
{
@@ -51,7 +55,7 @@ In the root folder of your project, create or edit a file called `import_map.jso
5155
}
5256
```
5357

54-
**Note: The trailing slashes are important!**
58+
_Replace `x.y.z` with the desired version._
5559

5660
In this way you can use relative imports from Rimbu in your code, like so:
5761

@@ -85,20 +89,18 @@ console.log(arr);
8589

8690
## Author
8791

88-
[Arvid Nicolaas](https://github.com/vitoke)
92+
Created and maintained by [Arvid Nicolaas](https://github.com/vitoke).
8993

9094
## Contributing
9195

92-
Feel very welcome to contribute to further improve Rimbu. Please read our [Contributing guide](https://github.com/rimbu-org/rimbu/blob/main/CONTRIBUTING.md).
96+
We welcome contributions! Please read our [Contributing guide](https://github.com/rimbu-org/rimbu/blob/main/CONTRIBUTING.md).
9397

9498
## Contributors
9599

96100
<img src = "https://contrib.rocks/image?repo=rimbu-org/rimbu"/>
97101

98-
Made with [contributors-img](https://contrib.rocks).
102+
_Made with [contributors-img](https://contrib.rocks)._
99103

100104
## License
101105

102-
Licensed under the MIT License, Copyright © 2020-present Arvid Nicolaas.
103-
104-
See [LICENSE](./LICENSE) for more information.
106+
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) for details.

‎deno_dist/bimap/README.md

Lines changed: 40 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -8,52 +8,61 @@
88

99
# @rimbu/bimap
1010

11-
A BiMap is a bidirectional Map of keys and values, where each key has exactly one value, and each value has exactly one key. There is a one-to-one mapping between keys and values.
11+
Welcome to `@rimbu/bimap`! A BiMap is a powerful bidirectional map that ensures a one-to-one mapping between keys and values. Each key is associated with exactly one value, and each value is associated with exactly one key.
1212

13-
This package exports the following types:
13+
### Key Features:
1414

15-
| Name | Description |
16-
| ------------------- | ---------------------------------------------------------------------------------------------- |
17-
| `BiMap<K, V>` | a generic BiMap between keys of type K and values of type V |
18-
| `HashBiMap<K, V>` | a BiMap between keys of type K and values of type V, where both the keys and values are hashed |
19-
| `SortedBiMap<K, V>` | a BiMap between keys of type K and values of type V, where both the keys and values are sorted |
15+
- **Bidirectional Mapping**: Effortlessly navigate between keys and values.
16+
- **Unique Associations**: Guarantees unique key-value pairs, ensuring data integrity.
2017

21-
For complete documentation please visit the [BiMap page](https://rimbu.org/docs/collections/bimap) in the _[Rimbu Docs](https://rimbu.org)_, or directly see the _[Rimbu BiMap API Docs](https://rimbu.org/api/rimbu/bimap)_.
18+
### Exported Types:
2219

23-
Or [Try Out Rimbu](https://codesandbox.io/s/github/vitoke/rimbu-sandbox/tree/main?previewwindow=console&view=split&editorsize=65&moduleview=1&module=/src/index.ts) in CodeSandBox.
20+
| Name | Description |
21+
| ------------------- | --------------------------------------------------------------------------------------- |
22+
| `BiMap<K, V>` | A generic BiMap for keys of type `K` and values of type `V`. |
23+
| `HashBiMap<K, V>` | A BiMap where both keys and values are hashed for efficient lookups. |
24+
| `SortedBiMap<K, V>` | A BiMap where both keys and values are sorted, providing ordered traversal and lookups. |
25+
26+
### Documentation
27+
28+
For complete documentation, please visit the [BiMap page](https://rimbu.org/docs/collections/bimap) in the [Rimbu Docs](https://rimbu.org), or directly explore the [Rimbu BiMap API Docs](https://rimbu.org/api/rimbu/bimap).
29+
30+
### Try It Out
31+
32+
Experience `@rimbu/bimap` in action! [Try Out Rimbu](https://codesandbox.io/s/github/vitoke/rimbu-sandbox/tree/main?previewwindow=console&view=split&editorsize=65&moduleview=1&module=/src/index.ts) on CodeSandBox.
2433

2534
## Installation
2635

2736
### Compabitity
2837

29-
- [`Node >= 16` ![NodeJS](https://img.shields.io/badge/node.js-6DA55F?logo=node.js&logoColor=white)](https://nodejs.org)
38+
- [`Node` ![NodeJS](https://img.shields.io/badge/node.js-6DA55F?logo=node.js&logoColor=white)](https://nodejs.org)
3039
- [`Deno` ![Deno JS](https://img.shields.io/badge/deno%20js-000000?logo=deno&logoColor=white)](https://deno.com/runtime)
31-
- [`Bun >= 0.6.0` ![Bun](https://img.shields.io/badge/Bun-%23000000.svg?logoColor=white)](https://bun.sh/)
40+
- [`Bun` ![Bun](https://img.shields.io/badge/Bun-%23000000.svg?logoColor=white)](https://bun.sh/)
3241
- `Web` ![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?logoColor=white)
3342

34-
### Yarn / NPM / Bun
35-
36-
For convenience, all main types are also exported through [`@rimbu/core`](../core).
37-
38-
To install this package only:
43+
### Package Managers
3944

40-
For `yarn`:
45+
**Yarn:**
4146

42-
> `yarn add @rimbu/bimap`
43-
44-
For `npm`:
47+
```sh
48+
yarn add @rimbu/bimap
49+
```
4550

46-
> `npm i @rimbu/bimap`
51+
**npm:**
4752

48-
For `bun`:
53+
```sh
54+
npm install @rimbu/bimap
55+
```
4956

50-
> `bun add @rimbu/bimap`
57+
**Bun:**
5158

52-
### Deno
59+
```sh
60+
bun add @rimbu/bimap
61+
```
5362

54-
For Deno, the following approach is recommended:
63+
### Deno Setup
5564

56-
In the root folder of your project, create or edit a file called `import_map.json` with the following contents (where you should replace `x.y.z` with the desired version of Rimbu):
65+
Create or edit `import_map.json` in your project root:
5766

5867
```json
5968
{
@@ -63,7 +72,7 @@ In the root folder of your project, create or edit a file called `import_map.jso
6372
}
6473
```
6574

66-
**Note: The trailing slashes are important!**
75+
_Replace `x.y.z` with the desired version._
6776

6877
In this way you can use relative imports from Rimbu in your code, like so:
6978

@@ -94,20 +103,18 @@ console.log(biMap.toString());
94103

95104
## Author
96105

97-
[Arvid Nicolaas](https://github.com/vitoke)
106+
Created and maintained by [Arvid Nicolaas](https://github.com/vitoke).
98107

99108
## Contributing
100109

101-
Feel very welcome to contribute to further improve Rimbu. Please read our [Contributing guide](https://github.com/rimbu-org/rimbu/blob/main/CONTRIBUTING.md).
110+
We welcome contributions! Please read our [Contributing guide](https://github.com/rimbu-org/rimbu/blob/main/CONTRIBUTING.md).
102111

103112
## Contributors
104113

105114
<img src = "https://contrib.rocks/image?repo=rimbu-org/rimbu"/>
106115

107-
Made with [contributors-img](https://contrib.rocks).
116+
_Made with [contributors-img](https://contrib.rocks)._
108117

109118
## License
110119

111-
Licensed under the MIT License, Copyright © 2020-present Arvid Nicolaas.
112-
113-
See [LICENSE](./LICENSE) for more information.
120+
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) for details.

0 commit comments

Comments
 (0)