diff --git a/README.md b/README.md index ac79544..796374a 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ - npm downloads + npm downloads Github Stars @@ -22,32 +22,28 @@ ## `Demo` - +
- - - - -
- Demo Test + Try using it in playground
- + + - + +
- - - -
## `Installing WAP-UI` +To use WAP UI, Install the `@wap-ui/react` package and its peer dependencies. +(`@emotion/react`, `@emotion/styled`, `framer-motion`) + ```sh yarn add @wap-ui/react @emotion/react @emotion/styled framer-motion # or @@ -56,6 +52,10 @@ npm i @wap-ui/react @emotion/react @emotion/styled framer-motion ## `Usage` +To start using the components, follow these steps: + +1. For WAP UI to work correctly, Wrap `WapUIProvider` provided by `@wap-ui/react` at root of your application. + ```tsx import React from 'react'; @@ -72,6 +72,8 @@ ReactDOM.createRoot(document.getElementById('root') as HTMLElement).render( ); ``` +2. Bring components what you want and use them. + ```tsx import { Button } from '@wap-ui/react'; @@ -86,14 +88,60 @@ const Home = () => { export default Home; ``` -## `Contributors` - -### [성준영](https://github.com/sjyoung428)(소프트웨어·인공지능전공 16학번) +3. You can refer to the components through Documents or Jsdocs like that. + + + + + + + + + +
+ Documents + + Jsdocs +
+ + + +
-### [이예슬](https://github.com/mimpie)(소프트웨어·인공지능전공 21학번) +## `Contributors` -### [김민수](https://github.com/neko113)(컴퓨터공학전공 19학번) + + + + + + + + + + + +
+ + +
+ neko113 💻 + 		+ + +
+ sjyoung428 💻 + 		+ + +
+ mimpie 💻 +
컴공19 김민수컴공16 성준영컴공21 이예슬
## `Links` -### [Docs](https://github.com/pknu-wap/wap-ui/tree/main/docs) / [NPM](https://www.npmjs.com/package/wap-ui) / [Storybook](https://wap-ui.vercel.app/) / [PPT](https://github.com/pknu-wap/wap-ui/tree/main/ppt) / [Example](https://github.com/pknu-wap/wap-ui/tree/main/example) +- #### [Documents](https://github.com/pknu-wap/wap-ui/tree/main/docs) +- #### [NPM](https://www.npmjs.com/package/wap-ui) +- #### [Playground](https://wap-ui.vercel.app/) +- #### [Presentations](https://github.com/pknu-wap/wap-ui/tree/main/ppt) +- #### [Example](https://github.com/pknu-wap/wap-ui/tree/main/example) diff --git a/example/react-ts/package.json b/example/react-ts/package.json index 5116d7a..42102f1 100644 --- a/example/react-ts/package.json +++ b/example/react-ts/package.json @@ -11,7 +11,7 @@ "dependencies": { "@emotion/react": "^11.10.5", "@emotion/styled": "^11.10.5", - "@wap-ui/react": "^1.3.0", + "@wap-ui/react": "^1.3.2", "framer-motion": "^7.6.15", "react": "^18.2.0", "react-dom": "^18.2.0" diff --git a/example/react-ts/yarn.lock b/example/react-ts/yarn.lock index 5489b9c..bf5f736 100644 --- a/example/react-ts/yarn.lock +++ b/example/react-ts/yarn.lock @@ -567,10 +567,10 @@ magic-string "^0.26.7" react-refresh "^0.14.0" -"@wap-ui/react@^1.3.0": - version "1.3.0" - resolved "https://registry.yarnpkg.com/@wap-ui/react/-/react-1.3.0.tgz#6570a875536e723643184cc1330f594c9672c6b2" - integrity sha512-vqYEfCOIUU8oinkGe+oV2MNnXwt8EhleZgz5N4ekfjt7/uhRovnMNFhbjrIKMOr1id9BCYbmts1pxBud8MdZKg== +"@wap-ui/react@^1.3.2": + version "1.3.2" + resolved "https://registry.yarnpkg.com/@wap-ui/react/-/react-1.3.2.tgz#000708a4851ee01f6611c1f3b0e1c30a291d62c6" + integrity sha512-B9tvID8PuFepEy2z5+iQFpHykqmdneeRgRFKs9T4o3PjraB84lCTlbxqfnNeX+IA34+LLr6EtH2Sg9BAzlUOBA== dependencies: "@emotion/react" "^11.10.4" "@emotion/styled" "^11.10.4" diff --git a/packages/react/README.md b/packages/react/README.md index ac79544..796374a 100644 --- a/packages/react/README.md +++ b/packages/react/README.md @@ -8,7 +8,7 @@ - npm downloads + npm downloads Github Stars @@ -22,32 +22,28 @@ ## `Demo` - +
- - - - -
- Demo Test + Try using it in playground
- + + - + +
- - - -
## `Installing WAP-UI` +To use WAP UI, Install the `@wap-ui/react` package and its peer dependencies. +(`@emotion/react`, `@emotion/styled`, `framer-motion`) + ```sh yarn add @wap-ui/react @emotion/react @emotion/styled framer-motion # or @@ -56,6 +52,10 @@ npm i @wap-ui/react @emotion/react @emotion/styled framer-motion ## `Usage` +To start using the components, follow these steps: + +1. For WAP UI to work correctly, Wrap `WapUIProvider` provided by `@wap-ui/react` at root of your application. + ```tsx import React from 'react'; @@ -72,6 +72,8 @@ ReactDOM.createRoot(document.getElementById('root') as HTMLElement).render( ); ``` +2. Bring components what you want and use them. + ```tsx import { Button } from '@wap-ui/react'; @@ -86,14 +88,60 @@ const Home = () => { export default Home; ``` -## `Contributors` - -### [성준영](https://github.com/sjyoung428)(소프트웨어·인공지능전공 16학번) +3. You can refer to the components through Documents or Jsdocs like that. + + + + + + + + + +
+ Documents + + Jsdocs +
+ + + +
-### [이예슬](https://github.com/mimpie)(소프트웨어·인공지능전공 21학번) +## `Contributors` -### [김민수](https://github.com/neko113)(컴퓨터공학전공 19학번) + + + + + + + + + + + +
+ + +
+ neko113 💻 + 		+ + +
+ sjyoung428 💻 + 		+ + +
+ mimpie 💻 +
컴공19 김민수컴공16 성준영컴공21 이예슬
## `Links` -### [Docs](https://github.com/pknu-wap/wap-ui/tree/main/docs) / [NPM](https://www.npmjs.com/package/wap-ui) / [Storybook](https://wap-ui.vercel.app/) / [PPT](https://github.com/pknu-wap/wap-ui/tree/main/ppt) / [Example](https://github.com/pknu-wap/wap-ui/tree/main/example) +- #### [Documents](https://github.com/pknu-wap/wap-ui/tree/main/docs) +- #### [NPM](https://www.npmjs.com/package/wap-ui) +- #### [Playground](https://wap-ui.vercel.app/) +- #### [Presentations](https://github.com/pknu-wap/wap-ui/tree/main/ppt) +- #### [Example](https://github.com/pknu-wap/wap-ui/tree/main/example) diff --git a/packages/react/package.json b/packages/react/package.json index 5ea5cd8..ac556df 100644 --- a/packages/react/package.json +++ b/packages/react/package.json @@ -1,6 +1,6 @@ { "name": "@wap-ui/react", - "version": "1.3.0", + "version": "1.3.2", "description": "WAP UI / React UI Components Library", "repository": "https://github.com/pknu-wap/2022_2_WAP_WEB_TEAM1.git", "author": "neko113 ",