Skip to content

Commit

Permalink
docs: update README (a88c793)
Browse files Browse the repository at this point in the history
  • Loading branch information
Xvezda committed Dec 17, 2021
1 parent 08933b0 commit d2e7083
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 2 deletions.
34 changes: 33 additions & 1 deletion README.ejs
Original file line number Diff line number Diff line change
@@ -1,7 +1,39 @@
# :eyes: vom.js ![gzip size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/vomjs/dist/vom.js?label=gzip&compression=gzip) ![npm version](https://img.shields.io/npm/v/vomjs)
React-like 인터페이스를 제공하는 SPA 프레임워크

`vom.js`는 React-like API를 제공하는 UI 프레임워크입니다.


## Demo

<%= demos.map(demo => `- [**${demo.name}**](https://${demo.id}.csb.app): [Sandbox](https://codesandbox.io/s/${demo.id}) | [Source](${demo.path})`).join('\n') %>

## Install

Npm
```sh
npm i vomjs
```

Yarn
```sh
yarn add vomjs
```

CDN
```html
<script src="https://cdn.jsdelivr.net/npm/vomjs"></script>
```

## Goals
- [ ] Hooks API 구현
- [x] `useState`
- [x] `useEffect`
- [ ] `useContext`
- [x] `useReducer`
- [x] `useCallback`
- [x] `useMemo`
- [x] `useRef`
- [ ] `useImperativeHandle`
- [ ] `useLayoutEffect`
- [ ] `useDebugValue`
- [ ] 서버사이드 렌더링 지원
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,41 @@
# :eyes: vom.js ![gzip size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/vomjs/dist/vom.js?label=gzip&compression=gzip) ![npm version](https://img.shields.io/npm/v/vomjs)
React-like 인터페이스를 제공하는 SPA 프레임워크

`vom.js`는 React-like API를 제공하는 UI 프레임워크입니다.


## Demo

- [**basic-routing**](https://f3udr.csb.app): [Sandbox](https://codesandbox.io/s/f3udr) | [Source](examples/basic-routing)
- [**counter**](https://ci6sp.csb.app): [Sandbox](https://codesandbox.io/s/ci6sp) | [Source](examples/counter)
- [**tic-tac-toe**](https://hm5wl.csb.app): [Sandbox](https://codesandbox.io/s/hm5wl) | [Source](examples/tic-tac-toe)

## Install

Npm
```sh
npm i vomjs
```

Yarn
```sh
yarn add vomjs
```

CDN
```html
<script src="https://cdn.jsdelivr.net/npm/vomjs"></script>
```

## Goals
- [ ] Hooks API 구현
- [x] `useState`
- [x] `useEffect`
- [ ] `useContext`
- [x] `useReducer`
- [x] `useCallback`
- [x] `useMemo`
- [x] `useRef`
- [ ] `useImperativeHandle`
- [ ] `useLayoutEffect`
- [ ] `useDebugValue`
- [ ] 서버사이드 렌더링 지원

0 comments on commit d2e7083

Please sign in to comment.