Skip to content

Commit

Permalink
Installer and examples are added
Browse files Browse the repository at this point in the history
  • Loading branch information
UpperCod committed May 31, 2019
1 parent 0653d69 commit 1e15f42
Showing 1 changed file with 33 additions and 3 deletions.
36 changes: 33 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,48 @@ function WebComponent() {
customElement("web-component", WebComponent);
```

1. [installation](#installation)
1. [Installation, `npm init @atomico`](#installation)
2. [Hooks](#hooks)
1. [useState](#usestate)
2. [useEffect](#useeffect)
3. [useReducer](#usereducer)
4. [useMemo](#usememo)
5. [useRef](#useref)
6. [useHost](#usehost)
3. modules
3. Modules
1. [atomico/lazy](./docs/lazy.md)
2. [atomico/router](./docs/router.md)
4. examples
4. [Examples](https://github.com/atomicojs/examples)
1. [small store, PWA](https://atomicojs.github.io/examples/atomico-store/dist)
1. [small todo, PWA](https://atomicojs.github.io/examples/atomico-todo/dist)

## Installation

Atomico has a project generator, you can initialize using `npm init @atomico`.

```cmd
npm init @atomico
Welcome to Atomico, let's create your project
√ name? ... project-name
√ description? ... project-description
Ready!, check the folder ./project-name and ./project-name/README.md
Next step, commands!
cd project-name
yarn | npm i
```

Alternatively, if you have an existing project you can incorporate Atomico simply using, JS pragma used by Atomico is defined as part of the module exporting `h` or`createELement`.

```bash
npm install atomico
```

**⚠️ Remember Atomico is a modern package, which is distributed and maintained as an MJS module**

## Hooks

Expand Down

0 comments on commit 1e15f42

Please sign in to comment.