Skip to content

Commit 9bc9f1c

Browse files
committed
Update README.md
1 parent 6eb2c04 commit 9bc9f1c

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h1 align="center">[WIP]Ayanami</h1>
1+
<h1 align="center">Ayanami</h1>
22
<h4 align="center">
33
A better way to react with state. Inspired by <a href="https://github.com/LeetCode-OpenSource/redux-epics-decorator">redux-epics-decorator</a>
44
</h4>
@@ -32,25 +32,26 @@
3232
- No extra configuration, everything is out of the box
3333
- Define state and actions in a **predictable** and **type-safe** way
3434
- Use **[`RxJS`](https://rxjs-dev.firebaseapp.com)** to create side effects and more
35-
- **Single source of truth**: The model that extends from `Ayanami` is a singleton
3635
- **Debuggable**: Inspect actions and state changes via [`redux-devtools-extension`](https://github.com/zalmoxisus/redux-devtools-extension)
3736

3837
## Installation
3938

4039
##### Using [yarn](https://yarnpkg.com/en/package/ayanami):
4140

4241
```bash
43-
yarn add ayanami
42+
yarn add ayanami @asuka/di reflect-metadata rxjs
4443
```
4544

4645
##### Or via [npm](https://www.npmjs.com/package/ayanami):
4746

4847
```bash
49-
npm install ayanami
48+
npm install ayanami @asuka/di reflect-metadata rxjs
5049
```
5150

5251
## Examples
5352

54-
- <del>[Simple `Transient` demo with **useHooks**](https://codesandbox.io/s/8111031lml)</del>
55-
- <del>[Simple `Singleton` demo with **connect**](https://codesandbox.io/s/p9m3p5lnpq)</del>
56-
- <del>[Interact with other Ayanami](https://codesandbox.io/s/7jy59q34rj)</del>
53+
- [Reducer example](https://codesandbox.io/s/py5o3ojo7x)
54+
- [Effect example](https://codesandbox.io/s/nnko0rxjv4)
55+
- [Scope example](https://codesandbox.io/s/jlz44wrymw)
56+
- [Interact with other Ayanami example](https://codesandbox.io/s/ly5ol8xrqz)
57+
- [SameScope example](https://codesandbox.io/s/k97lqxwvn5)

0 commit comments

Comments
 (0)