diff --git a/README.md b/README.md index 3db5ffc..614dd67 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,8 @@ ![Pretty](https://github.com/lukasbach/synergies/workflows/Pretty/badge.svg) ![Storybook Deployment](https://github.com/lukasbach/synergies/workflows/Storybook%20Deployment/badge.svg) +Find out more at [synergies.js.org](https://synergies.js.org/)! + `synergies` is a tiny (>3kB), yet powerful state management library for React. It allows you to specify small state atoms, that you can combine into Synergys of multiple atoms that define shared state logic. Features include @@ -261,13 +263,6 @@ export const App = () => ( ## Maintenance -- Deployment automatically happens. Initialize GitHub Pages by going to the Repo's settings, scrolling down to - _GitHub Pages_, selecting the `gh-pages` branch and click on _Save_ (root directory is fine). -- Implement your components and hooks by copying the template packages. Make sure to adapt the package names, repository - url and author in the respective `package.json` files. -- Make sure to remove the template packages if you don't need them anymore. You can always copy them from the original - template repo again. - When developing locally, run in the root directory... - `yarn` to install dependencies diff --git a/todos.md b/todos.md index 5acb99a..b725814 100644 --- a/todos.md +++ b/todos.md @@ -10,3 +10,4 @@ to an array item of an array kept within an atom, without rerendering everytime some random array item changes. - Use hooks of atoms/synergies directly, like `const action = createAction()`, then `useAction(action)`? +- Add more relevant examples to todo