Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sigoden committed Sep 24, 2022
1 parent f16a1bb commit 3880204
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

A task runner using bash.

![demo](https://user-images.githubusercontent.com/4012553/192087589-241125ed-73b3-40e9-b753-9d6a5fc806ac.png)

- [runme](#runme)
- [Install](#install)
- [With cargo](#with-cargo)
Expand All @@ -31,7 +33,7 @@ A task runner using bash.
### With cargo

```
cargo install runme
cargo install --force runme
```

### Binaries on macOS, Linux, Windows
Expand Down Expand Up @@ -71,17 +73,19 @@ Adds a task by putting `@cmd` above a function.
```sh
# @cmd Build project
build() {
echo Build...
echo Run build
}
# @cmd Run tests
test() {
echo Test...
echo Run test
}
eval $(runme --runme-eval "$0" "$@")
```

> Run `runme --runme-crate build test` to quickly create a boilerplate Runmefile.sh.

### Task accepts flags, options and positional arguments

```sh
Expand Down

0 comments on commit 3880204

Please sign in to comment.