Skip to content

Commit

Permalink
Update README to include installation section (closes #18)
Browse files Browse the repository at this point in the history
  • Loading branch information
girvel committed Dec 19, 2024
1 parent 4baec14 commit 77513cb
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ Completing tasks:
looper done 1d 0e 0c
```

## Installation

```bash
cargo install girvel_looper
```

## Configuration

Schedule is set in single TOML file. Use `looper path schedule` to get the path. The sections are cron expression strings, defining frequency of the following routines; each key-value pair is a single routine: the key is a globally unique ID (any string that would be comfortable to use; I prefer two-digit hexadecimal numbers), the value is a full description.
Expand Down
2 changes: 1 addition & 1 deletion logic/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "girvel_looper"
version = "1.0.1"
version = "1.0.2"
authors = ["girvel"]
edition = "2021"
readme = "../README.md"
Expand Down

0 comments on commit 77513cb

Please sign in to comment.