Skip to content

Commit

Permalink
Merge pull request #12 from shoonia/v5
Browse files Browse the repository at this point in the history
V5
  • Loading branch information
shoonia authored Feb 12, 2024
2 parents ca4cffb + 29af292 commit 2591bed
Show file tree
Hide file tree
Showing 29 changed files with 494 additions and 1,585 deletions.
3 changes: 0 additions & 3 deletions .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,6 @@
"ecmaVersion": 2023,
"sourceType": "module"
},
"globals": {
"$w": "readonly"
},
"rules": {
"quotes": [
"error",
Expand Down
4 changes: 2 additions & 2 deletions .size-limit.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
{
"path": "lib/index.cjs",
"import": "{ createStoreon }",
"limit": "613 B"
"limit": "604 B"
},
{
"path": "lib/index.js",
"import": "{ createStoreon }",
"limit": "346 B"
"limit": "333 B"
}
]
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,6 @@ A tiny event-based state manager [Storeon](https://github.com/storeon/storeon) f

![state manager storeon-velo](https://static.wixstatic.com/shapes/e3b156_87008db048c84222aa5f0814b5572677.svg)

> **BREAKING CHANGE**
>
> `storeon-velo` is moving to `V4` with a few breaking changes
>
> - [Migrating to V4](https://github.com/shoonia/storeon-velo/blob/master/docs/MIGRATION_TO_V4.md)
> - [Legacy APIs docs](https://github.com/shoonia/storeon-velo/blob/master/docs/LEGACY.md)
## Example

```js
Expand Down Expand Up @@ -48,12 +41,18 @@ $w.onReady(() => {

## Install

You use the [Package Manager](https://support.wix.com/en/article/velo-working-with-npm-packages)
to manage the npm packages in your site.
### Velo

You use the [Package Manager](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/working-with-npm-packages)
to manage the npm packages in your Wix site.

[Check latest available version](https://www.wix.com/velo/npm-modules)
### NPM/Yarn

![Package Manager panel in Wix editor, installing storeon-velo](https://static.wixstatic.com/media/e3b156_89e4871c048b48538242a7568b7ed2de~mv2.jpg)
```bash
npm install storeon-velo
#or
yarn add storeon-velo
```

## API

Expand Down
4 changes: 4 additions & 0 deletions dev
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
npm run lint
npm run build
npm run test
npm run size
Loading

0 comments on commit 2591bed

Please sign in to comment.