Skip to content

Commit

Permalink
doc: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
konradmalik committed Dec 1, 2023
1 parent 3ceb53a commit c364aa2
Showing 1 changed file with 46 additions and 2 deletions.
48 changes: 46 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,53 @@
[![Actions Status](https://github.com/konradmalik/baywatch/actions/workflows/main.yml/badge.svg)](https://github.com/konradmalik/baywatch/actions)

# baywatch

Watch files and execute commands if they change.

## Installation

```
$ cargo install --locked baywatch
```

or

Use the provided package via flake

or

```
$ nix build
```

or

```
$ nix run
```

## Usage

```bash
$ bwatch --help
```

Simplest example:

```bash
$ bwatch -- ls -lah
```

## Assumptions

- simple
- simple codebase and usage
- sane defaults
- like using local gitignore properly
- using local gitignore properly
- ignores change events that happened since starting the scheduled command (not running tests 10 times if files changed
10 times)
- streams stdout and stderr
- tested and used only on Linux and Darwin, may or may not work on Windows

## Similar to

- [watchexec](https://github.com/watchexec/watchexec)

0 comments on commit c364aa2

Please sign in to comment.