diff --git a/README.ejs b/README.ejs index 864eeec..f9fda63 100644 --- a/README.ejs +++ b/README.ejs @@ -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 + +``` + +## Goals +- [ ] Hooks API 구현 + - [x] `useState` + - [x] `useEffect` + - [ ] `useContext` + - [x] `useReducer` + - [x] `useCallback` + - [x] `useMemo` + - [x] `useRef` + - [ ] `useImperativeHandle` + - [ ] `useLayoutEffect` + - [ ] `useDebugValue` +- [ ] 서버사이드 렌더링 지원 diff --git a/README.md b/README.md index cde228a..092782a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # :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 @@ -7,3 +9,33 @@ React-like 인터페이스를 제공하는 SPA 프레임워크 - [**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 + +``` + +## Goals +- [ ] Hooks API 구현 + - [x] `useState` + - [x] `useEffect` + - [ ] `useContext` + - [x] `useReducer` + - [x] `useCallback` + - [x] `useMemo` + - [x] `useRef` + - [ ] `useImperativeHandle` + - [ ] `useLayoutEffect` + - [ ] `useDebugValue` +- [ ] 서버사이드 렌더링 지원