Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lukasbach committed Apr 4, 2022
1 parent 1a82d0f commit acbe670
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 7 deletions.
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions todos.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit acbe670

Please sign in to comment.