Skip to content

Commit

Permalink
docs(readme): update README.md (#60)
Browse files Browse the repository at this point in the history
  • Loading branch information
fu050409 authored Jul 23, 2024
1 parent 6d644b4 commit b36c4c2
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 4 deletions.
2 changes: 2 additions & 0 deletions .changeset/witty-radios-wink.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
38 changes: 34 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,42 @@ Fast, powerful and elegant CLI build tool based on clap-rs

## Installation

```bash
npm install -g archons
```
1. Using npm

```bash
npm install --save-dev archons
```

2. Using pnpm

```bash
pnpm add -D archons
```

3. Using yarn

```bash
yarn add -D archons
```

4. Using bun

```bash
bun add -d archons
```

## Usage

Look at [Examples](./examples) for an example.
See [Examples](./examples) for examples.

See [clap-rs](https://github.com/clap-rs/clap) for more information.

## Inspiration

- [clap-rs](https://github.com/clap-rs/clap-rs) A full featured, fast Command Line Argument Parser for Rust.

- [citty](https://github.com/unjs/citty) An elegant CLI Builder created with nodejs.

## License

Released under [MIT](./LICENSE) license.

0 comments on commit b36c4c2

Please sign in to comment.