Skip to content

Commit

Permalink
feat: update package description
Browse files Browse the repository at this point in the history
  • Loading branch information
halfmoon-mind committed Aug 28, 2023
1 parent d725a9e commit f677afe
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 26 deletions.
1 change: 1 addition & 0 deletions .github/workflows/npm-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
23 changes: 8 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# up-d4te

> This readme is automatically generated by [create-ink-app](https://github.com/vadimdemedes/create-ink-app) <br>
> You can see project repository [here](https://github.com/gdsc-ssu/up-date-cli)
> This is the recommend dating course in korea with CLI. <br>
> This project is made by [ink](https://github.com/vadimdemedes/ink), you can own cli project with it.<br>
> You can see project repository [here](https://github.com/gdsc-ssu/up-date-cli).
## Install

Expand All @@ -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
```

Expand All @@ -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.
12 changes: 1 addition & 11 deletions source/cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -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(<App />);

0 comments on commit f677afe

Please sign in to comment.