Skip to content

Commit

Permalink
Merge pull request #13 from react-gx/dev
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
dilane3 authored Oct 13, 2023
2 parents b150895 + 0535d41 commit 530ecb2
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,11 @@ yarn add @dilane3/gx

## Prerequisites

This library doesn't work properly in strict mode. So to avoid some issues, please disable strict mode in your react application first before using it.
```bash
Since version `1.4.0` of `gx`, you can use it with `strict mode` enabled.
```

But, if you are using a version below `1.4.0`, you have to disable `strict mode` in your react application.

### Disabling strict mode on React

Expand Down Expand Up @@ -99,7 +103,13 @@ For handle it, there is a special `createSignal` function for this case.

**Actions** represent functions that act to the state and make it changing over the time.

Your have to specify these `actions` when you create yours `signals`.
You have to specify these `actions` when you create yours `signals`.

```txt
Since version `1.4.0` of `gx`, you can use `async` actions.
```

You can read more about it on the [documentation](https://gx.dilane3.com/docs/guide/async-actions)

### 3. Store

Expand Down Expand Up @@ -146,6 +156,8 @@ const counterSignal = createSignal({
export default counterSignal;
```

If you want to use `async` actions, you can learn more about it on the [documentation](https://gx.dilane3.com/docs/guide/async-actions)

### Third step: Creating your store.

Inside the `store` directory, create an `index.js` file.
Expand Down

0 comments on commit 530ecb2

Please sign in to comment.