awai - npm Package Compare versions

Comparing version 1.0.0-alpha-5 to 1.0.0-rc-1

package.json

 {
   "name": "awai",
-  "version": "1.0.0-alpha-5",
+  "version": "1.0.0-rc-1",
   "author": "Yuriy Yakym",
@@ -5,0 +5,0 @@ "description": "State management library",

README.md

@@ -17,3 +17,3 @@ <div align="center">
   
-  <p>| <a href="https://awai.vercel.app/">Documentation</a> | <a href="https://github.com/yuriyyakym/awai-react">Awai-React</a> |</p>
+  <p>| <a href="https://awai.js.org">Documentation</a> | <a href="https://awai.js.org/examples">Examples</a> | <a href="https://www.npmjs.com/package/awai">NPM</a> | <a href="https://github.com/yuriyyakym/awai-react">Awai-React</a> |</p>
 </div>
@@ -23,8 +23,38 @@
 
-## Examples
+## About
 
-- Paint - [Playground](https://codesandbox.io/p/github/yuriyyakym/awai-paint/master) | [Repository](https://github.com/yuriyyakym/awai-paint) | [Demo](https://awai-paint.vercel.app/)
+This library suggests an [architectural approach](https://awai.js.org/architecture), where every event is a promise-like (thennable) [AwaiEvent](https://awai.js.org/awai-event) with no terminal state.
 
-- Todo list - [Playground](https://codesandbox.io/p/sandbox/awai--todo-list-wqyjfz?file=%2FREADME.md%3A3%2C23)
+AwaiEvent is a fundamental part of this library. It can re-resolve infinite amount of times, and if you await it in a loop, you have an event listener replacement.
 
-- Safe counter - [Playground](https://codesandbox.io/p/sandbox/awai--cunter-qk7h6p?file=%2FREADME.md%3A3%2C23)
+Awai provides variety of nodes which were design to help with handling complex logics.
+Every Awai node has its events, which can be mixed into any async logics, or used as trigger for [Scenarios](https://awai.js.org/scenario).
+
+[Scenario](/scenario) is a powerful helper which helps to describe complex logics and events sequences using async functions.
+
+Awai helps with organizing asynchronous logics and handling race conditions with ease, and it's main goal is to completely extract business logics from UI layer.
+
+## Installation
+
+```sh
+npm install awai
+```
+
+## Documentation
+
+- [Quick start](https://awai.js.org/quick-start)
+- [Motivation](https://awai.js.org/motivation)
+- [Architecture](https://awai.js.org/architecture)
+- [Examples](https://awai.js.org/examples)
+- Awai nodes: [State](https://awai.js.org/state), [AsyncState](https://awai.js.org/async-state), [Selector](https://awai.js.org/selector), [Action](https://awai.js.org/action), [Scenario](https://awai.js.org/scenario), [FamilyState](https://awai.js.org/family-state), [Effect](https://awai.js.org/effect)
+- Other
+  - [AwaiEvent](https://awai.js.org/awai-event)
+  - [Registry](https://awai.js.org/registry)
+
+## Integrations
+
+- **React** - [NPM](https://www.npmjs.com/package/awai-react), [Repository](https://github.com/yuriyyakym/awai-react)
+
+## Name meaning
+
+The name comes from a Thai phrase [เอาไว้](https://www.thai2english.com/dictionary/1457374.html) which means "to keep/save/store for later".

No alert changes

Improved metrics

Total package byte prevSize

181864

increased by0.86%

Number of lines in readme file

59

increased by103.45%

No dependency changes