From f677afe14b033d759559da7e96096aa662f0a1b9 Mon Sep 17 00:00:00 2001 From: Sanghyeon Sim <5338095@gmail.com> Date: Tue, 29 Aug 2023 02:04:29 +0900 Subject: [PATCH] feat: update package description --- .github/workflows/npm-publish.yml | 1 + README.md | 23 ++++++++--------------- source/cli.js | 12 +----------- 3 files changed, 10 insertions(+), 26 deletions(-) diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml index e9abe48..d4dfb68 100644 --- a/.github/workflows/npm-publish.yml +++ b/.github/workflows/npm-publish.yml @@ -27,6 +27,7 @@ jobs: node-version: 16 registry-url: https://registry.npmjs.org/ - run: npm ci + - run: echo "KAKAO_API_KEY=${{ secrets.kakao_key }}" >> .env - run: npm run build - run: npm publish env: diff --git a/README.md b/README.md index a87058c..7783111 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # up-d4te -> This readme is automatically generated by [create-ink-app](https://github.com/vadimdemedes/create-ink-app)
-> You can see project repository [here](https://github.com/gdsc-ssu/up-date-cli) +> This is the recommend dating course in korea with CLI.
+> This project is made by [ink](https://github.com/vadimdemedes/ink), you can own cli project with it.
+> You can see project repository [here](https://github.com/gdsc-ssu/up-date-cli). ## Install @@ -12,25 +13,15 @@ $ npm install --global up-d4te ## CLI ``` -$ up-d4te --help - - Usage - $ up-d4te - - Options - --name Your name - - Examples - $ up-d4te --name=Jane - Hello, Jane +$ up-d4te ``` ## For Developer -for install packages and make watcher for build program +for install packages and run dev local server ```bash -$ npm i +$ npm ci $ npm run dev ``` @@ -39,3 +30,5 @@ and run in another terminal ```bash $ npm start ``` + +and you need to make [kakao api key](https://developers.kakao.com/docs/latest/ko/local/dev-guide#search-by-keyword) file in `.env` file to root directory of project. diff --git a/source/cli.js b/source/cli.js index 0ee6c35..c47d025 100644 --- a/source/cli.js +++ b/source/cli.js @@ -7,18 +7,8 @@ import App from './app.js'; const cli = meow( ` Usage - $ up-d4te - - Options - --name Your name - - Examples - $ up-d4te --name=Jane - Hello, Jane + $ up-date `, - { - importMeta: import.meta, - }, ); render();