build: github actions

Author: amized

.github/workflows/nodejs.yml

@@ -14,6 +14,8 @@ jobs:
           node-version: 12
           registry-url: https://registry.npmjs.org/
       - run: yarn install
+      - run: yarn test
+      - run: yarn build
       - run: npm publish --access public
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.travis.yml

@@ -13,8 +13,8 @@ script:
   - npm run test:prod && npm run build
 after_success:
   - npm run travis-deploy-once "npm run report-coverage"
-  - if [ "$TRAVIS_BRANCH" = "master" -a "$TRAVIS_PULL_REQUEST" = "false" ]; then npm run travis-deploy-once "npm run deploy-docs"; fi
-  - if [ "$TRAVIS_BRANCH" = "master" -a "$TRAVIS_PULL_REQUEST" = "false" ]; then npm run travis-deploy-once "npm run semantic-release"; fi
+  - if [ "$TRAVIS_BRANCH" = "master" -a "$TRAVIS_PULL_REQUEST" = "false" ]; then
+    npm run travis-deploy-once "npm run semantic-release"; fi
 branches:
   except:
     - /^v\d+\.\d+\.\d+$/

CONTRIBUTING.md

@@ -2,14 +2,14 @@
 
 _Next generation global state management for React, without the bloat._
 
-The idea of Freedux is to give you a single, immutable, strongly typed object
-tree that can be used to store and manage the state of your application. This is
-a similar concept to redux, but unlike redux, the Api is super simple and
-requires minimum set up code to use.
+Freedux gives you a single, immutable, strongly typed object tree that can be
+used to store and manage the state of your application. This is a similar
+concept to redux, but unlike redux, the Api is super simple and requires hardly
+any set up to start using.
 
 ## Documentation
 
-[Documentation Site](https://amized.github.io/freedux)
+[Documentation Site](https://amized.github.io/freedux/#/README)
 
 ## Features
 

README.md

@@ -0,0 +1,79 @@
+# Freedux
+
+_Next generation global state management for React, without the bloat._
+
+Freedux gives you a single, immutable, strongly typed object tree that can be
+used to store and manage the state of your application. This is a similar
+concept to redux, but unlike redux, the Api is super simple and requires hardly
+any set up to start using.
+
+## Features
+
+- Lightweight - 5k zipped
+- 0 dependencies
+- Modern hooks based API
+- Render optimization
+- APIs for usage outside of React
+- State data stored as plain JS primitives and objects
+- Strongly typed
+
+This project uses a fork from the
+[ts-object-path](https://github.com/Taras-Tymchiy/ts-object-path#readme)
+library.
+
+## Install
+
+```console
+npm install freedux
+```
+
+## Usage
+
+### 1. Create your store
+
+```javascript
+import { createStore } from 'freedux';
+
+// Define your initial state
+const initialState = {
+  count: 0
+};
+
+// Create your store to retrieve some hooks
+const { useListener, useSetter } = createStore(initialState);
+```
+
+### 2. Listen to state changes
+
+Use the `useListener` hook to select and inject state into your component:
+
+```javascript
+const CountDisplay = () => {
+  const count = useListener(state => state.count);
+  return <>{count}</>;
+};
+```
+
+### 3. Make updates
+
+Use the `useSetter` hook to update your store. You pass a function that returns
+the property you want to update. The hook returns a setter function to do that
+work:
+
+```javascript
+const CountButton = () => {
+  const setCount = useSetter(state => state.count);
+  return (
+    <button
+      onClick={() => {
+        setCount(5);
+      }}
+    >
+      Set the counter to 5
+    </button>
+  );
+};
+```
+
+Those are the basics. Check out the [example](example.md) and
+[API docs](store.md), and happy coding!

docs/README.md

@@ -1,6 +1,6 @@
 - About
 
-  - [Introduction](introduction.md)
+  - [Introduction](README.md)
   - [Example](example.md)
 
 - API

docs/_sidebar.md

@@ -17,7 +17,7 @@
       loadSidebar: true,
       subMaxLevel: 2,
       auto2top: true,
-      homepage: 'introduction.md',
+      homepage: 'README.md',
     }
   </script>
   <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>