Skip to content

Commit

Permalink
Merge pull request #12 from k3ii/update-read-me-installation
Browse files Browse the repository at this point in the history
Add installation section in readme
  • Loading branch information
k3ii authored Sep 1, 2024
2 parents 81acee6 + c0bed47 commit 44728a0
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# qdir - Quick Directory Creator

`qdir` is a command-line tool for creating directories with randomly generated names. It's useful when you need a quick directory without thinking about names.

## Features
Expand All @@ -9,15 +10,33 @@
- Use system temp directory or current working directory

## Usage

Basic: `qdir`

With options: qdir [options]

## Options

- `-d, --depth <depth>` Set depth for nested directories
- `-l, --length <length>` Set length for random string
- `-n, --name` Use names instead of random string
- `-p, --pet` Use pets instead of random string
- `-t, --tmp` Use the system's temporary directory
- `-h, --help` Print help
- `-V, --version` Print version

## Installation

You can install `qdir` using `cargo`:

```sh
cargo install qdir
```

Or using `brew`:

```sh
brew install k3ii/tap/qdir
```

**Check the [release page](https://github.com/k3ii/qdir/releases) to install the pre-built binaries.**

0 comments on commit 44728a0

Please sign in to comment.