Skip to content

Commit

Permalink
πŸ“˜ docs: update readme with v flag
Browse files Browse the repository at this point in the history
  • Loading branch information
Rettend committed Jan 21, 2024
1 parent 7aa58e5 commit 508e512
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 10 deletions.
12 changes: 3 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,16 +96,12 @@ Go to the [Config](#-config) section for [examples](#simple-demonstration) and t

The cli tool also has some commands for removing `eemoji` from a repository, running it manually, etc. But they are not that important. πŸ‘‡

<details>
<summary><h3>Commands</h3></summary>
### Commands

Use `eemoji <command>` if you installed it globally, or `npx eemoji <command>` if you installed it locally.

Use the help command to see all available commands and flags.

`eemoji -h` or `eemoji --help`

In addition, check the version with `eemoji --version`.
- `-h, --help`: show help for a command
- `-v, --version`: show version

#### 🚩 Init

Expand Down Expand Up @@ -152,8 +148,6 @@ eemoji run
- `-d, --debug`: the debug level, `0` for none, `1` for some, `2` for all
- `-t, --test`: test mode, input a commit message instead of a file

</details>

## 🦾 Config

The default configuration is here: [emojis.json](./src/emojis.json) and the [Emojis](#-emojis) section.
Expand Down
2 changes: 1 addition & 1 deletion src/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ export const main = defineCommand({
subCommands: commands,
run({ args }) {
if (args.version)
consola.log(`😎 ${name} v${version}`)
consola.log(`😎 ${name} \`v${version}\``)
},
})

0 comments on commit 508e512

Please sign in to comment.