From e4351ec110d924b78d0c4b1c8670c29eac452a21 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EA=B9=80=EB=AF=BC=EC=88=98=20MINSOO=20KIM?= Date: Mon, 26 Dec 2022 22:53:39 +0900 Subject: [PATCH 01/10] =?UTF-8?q?docs:=20=EC=82=AC=EC=9A=A9=EB=B2=95=20?= =?UTF-8?q?=EC=84=A4=EB=AA=85=20=EC=B6=94=EA=B0=80=20(#81)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ac79544..e0ba77c 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ @@ -48,6 +48,9 @@ ## `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 +59,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 +79,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,6 +95,18 @@ const Home = () => { export default Home; ``` +3. You can refer to the components through Documents or Jsdocs like that. +
- Demo Test + Try using it in playground
+ + + + +
+ + + +
+ ## `Contributors` ### [성준영](https://github.com/sjyoung428)(소프트웨어·인공지능전공 16학번) @@ -96,4 +117,8 @@ export default Home; ## `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) +- #### [Docometation](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) From 9340f9ec3f0f7b31c4c48e4af7b14ad45103ce60 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EA=B9=80=EB=AF=BC=EC=88=98=20MINSOO=20KIM?= Date: Mon, 26 Dec 2022 22:58:50 +0900 Subject: [PATCH 02/10] =?UTF-8?q?docs:=20jsdocs=20image=20=EB=B3=80?= =?UTF-8?q?=EA=B2=BD=20=20(#81)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e0ba77c..2487889 100644 --- a/README.md +++ b/README.md @@ -102,7 +102,7 @@ export default Home; - + From 653cab0bc8c623d8cc9c8a1e8687ca18fd607342 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EA=B9=80=EB=AF=BC=EC=88=98=20MINSOO=20KIM?= Date: Mon, 26 Dec 2022 23:10:41 +0900 Subject: [PATCH 03/10] docs: add contributors image (#81) --- README.md | 32 +++++++++++++++++++++++++++----- 1 file changed, 27 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2487889..8694978 100644 --- a/README.md +++ b/README.md @@ -109,11 +109,33 @@ export default Home; ## `Contributors` -### [성준영](https://github.com/sjyoung428)(소프트웨어·인공지능전공 16학번) - -### [이예슬](https://github.com/mimpie)(소프트웨어·인공지능전공 21학번) - -### [김민수](https://github.com/neko113)(컴퓨터공학전공 19학번) + + + + + + + + + + + +
+ + +
+ sjyong428 💻 + 		+ + +
+ neko113 💻 + 		+ + +
+ mimpie 💻 +
컴공16 성준영컴공19 김민수컴공21 이예슬
## `Links` From 0414133051d48eac854e8b8a7d9f85a3af33fd1c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EA=B9=80=EB=AF=BC=EC=88=98=20MINSOO=20KIM?= Date: Mon, 26 Dec 2022 23:49:39 +0900 Subject: [PATCH 04/10] Update README.md --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8694978..336e732 100644 --- a/README.md +++ b/README.md @@ -98,13 +98,12 @@ export default Home; 3. You can refer to the components through Documents or Jsdocs like that. - - -
- + + - + +
## `Contributors` From 0b3710bf171bc7e6ea911a50c9413263cb317142 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EA=B9=80=EB=AF=BC=EC=88=98=20MINSOO=20KIM?= Date: Tue, 27 Dec 2022 00:19:04 +0900 Subject: [PATCH 05/10] Update README.md --- README.md | 46 ++++++++++++++++++++++++---------------------- 1 file changed, 24 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 336e732..ecc8498 100644 --- a/README.md +++ b/README.md @@ -22,27 +22,20 @@ ## `Demo` - +
- - - - -
Try using it in playground
- + + - + +
- - - -
@@ -97,31 +90,40 @@ export default Home; 3. You can refer to the components through Documents or Jsdocs like that. + + + + +
+ Documents + + Jsdocs +
- +
## `Contributors` - + - - + +
- - -
- sjyong428 💻 -
neko113 💻 		+ + +
+ sjyoung428 💻 + 		@@ -129,16 +131,16 @@ export default Home; mimpie 💻
컴공16 성준영
컴공19 김민수컴공16 성준영 컴공21 이예슬
## `Links` -- #### [Docometation](https://github.com/pknu-wap/wap-ui/tree/main/docs) +- #### [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) From 6a5d7ed31b3bc750cb2fd58245ec895b7cdbf800 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EA=B9=80=EB=AF=BC=EC=88=98=20MINSOO=20KIM?= Date: Tue, 27 Dec 2022 00:22:48 +0900 Subject: [PATCH 06/10] =?UTF-8?q?docs:=20download=20badge=20=EC=88=98?= =?UTF-8?q?=EC=A0=95=20(#81)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ecc8498..796374a 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ - npm downloads + npm downloads Github Stars From ed41a23c7ff1edb4cdf4913e8a468342d1abbae1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EA=B9=80=EB=AF=BC=EC=88=98=20MINSOO=20KIM?= Date: Tue, 27 Dec 2022 00:23:17 +0900 Subject: [PATCH 07/10] v1.3.1 --- packages/react/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/react/package.json b/packages/react/package.json index 5ea5cd8..e0b24a0 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.1", "description": "WAP UI / React UI Components Library", "repository": "https://github.com/pknu-wap/2022_2_WAP_WEB_TEAM1.git", "author": "neko113 ", From d0b57294bb8c2462482e5cddafdba5c697438315 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EA=B9=80=EB=AF=BC=EC=88=98=20MINSOO=20KIM?= Date: Tue, 27 Dec 2022 00:25:24 +0900 Subject: [PATCH 08/10] =?UTF-8?q?docs:=20readme=20downloads=20badge=20?= =?UTF-8?q?=EC=88=98=EC=A0=95=20(#81)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- example/react-ts/package.json | 2 +- example/react-ts/yarn.lock | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/example/react-ts/package.json b/example/react-ts/package.json index 5116d7a..72e4f75 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.1", "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..ac7a5d6 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.1": + version "1.3.1" + resolved "https://registry.yarnpkg.com/@wap-ui/react/-/react-1.3.1.tgz#3657ced567d707cdc05c6434270b05c7e306fd7d" + integrity sha512-a4cc5LLLpWruDov9Tjx47aKJFB65nyZDFeEdNC9NHCOTUHnVnU+2xC5zPdOdcVC7tJsWFjM4UoKNFxv0geuNbQ== dependencies: "@emotion/react" "^11.10.4" "@emotion/styled" "^11.10.4" From e6a637aa8ba308fdb6003a543c2abe0e55f2614f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EA=B9=80=EB=AF=BC=EC=88=98=20MINSOO=20KIM?= Date: Tue, 27 Dec 2022 00:26:28 +0900 Subject: [PATCH 09/10] v1.3.2 --- packages/react/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/react/package.json b/packages/react/package.json index e0b24a0..ac556df 100644 --- a/packages/react/package.json +++ b/packages/react/package.json @@ -1,6 +1,6 @@ { "name": "@wap-ui/react", - "version": "1.3.1", + "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 ", From 52aba3b40ccb1fcba17d7152f148c2444728e963 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EA=B9=80=EB=AF=BC=EC=88=98=20MINSOO=20KIM?= Date: Tue, 27 Dec 2022 00:27:44 +0900 Subject: [PATCH 10/10] chore: example version upgrade (#81) --- example/react-ts/package.json | 2 +- example/react-ts/yarn.lock | 8 ++-- packages/react/README.md | 88 +++++++++++++++++++++++++++-------- 3 files changed, 73 insertions(+), 25 deletions(-) diff --git a/example/react-ts/package.json b/example/react-ts/package.json index 72e4f75..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.1", + "@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 ac7a5d6..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.1": - version "1.3.1" - resolved "https://registry.yarnpkg.com/@wap-ui/react/-/react-1.3.1.tgz#3657ced567d707cdc05c6434270b05c7e306fd7d" - integrity sha512-a4cc5LLLpWruDov9Tjx47aKJFB65nyZDFeEdNC9NHCOTUHnVnU+2xC5zPdOdcVC7tJsWFjM4UoKNFxv0geuNbQ== +"@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)