Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Chemaclass committed Oct 5, 2024
1 parent 3282754 commit bbbb085
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,35 @@ A minimalistic and straightforward **bash dependency manager**.

### Usage

#### bashdep::install

You can distinguish between regular dependencies and dev-dependencies when defining the URL.
Dev-dependencies ends with `@dev`

```bash
DEPENDENCIES=(
"https://github.com/[...]/download/0.17.0/bashunit"
"https://github.com/[...]/download/0.1/dumper.sh@dev"
)

bashdep::install "${DEPENDENCIES[@]}"
```

#### bashdep::setup

Alternately, you can configure the default values of bashdep using the setup function.

- `dir=string`: set the default destination directory. Default: `lib`
- `dev-dir=string`: set the development destination directory. Default: `lib/dev`
- `silent=bool`: if true, no progress text will be shown during installation. Default: `false`

```bash
bashdep::setup dir="lib" dev-dir="src/dev" silent=false
bashdep::install "${DEPENDENCIES[@]}"
```

### Demo

Usage example from
[Chemaclass/bash-skeleton](https://github.com/Chemaclass/bash-skeleton/blob/main/install-dependencies.sh)

Expand Down

0 comments on commit bbbb085

Please sign in to comment.