Skip to content

Commit 41222bf

Browse files
authored
Better README and example file (#4)
1 parent 1cf7337 commit 41222bf

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22

33
**nof** is a tiny CLI tool that runs shell commands defined in simple YAML templates.
44

5-
:exclamation: This is a working in progress, so the code might be messy, tests might be lacking
6-
and things might break frequently.
5+
:exclamation: This is a work in progress, so the code might be messy, tests might be lacking
6+
and things might break frequently. If you want a better version that has many more features visit [this](https://github.com/go-task/task) repo.
7+
I just wanted something much more minimalistic that has a more readable and simpler yaml syntax.
78

89
## Example
910

@@ -22,32 +23,36 @@ Use the following YAML file:
2223
# find.yaml
2324
find:
2425
- "/var/log"
25-
- "\"*.log\""
26+
- "*.log"
2627
- "-mtime"
2728
- "-3"
2829
```
2930
3031
Then run:
3132
3233
```
33-
nof /path/to/find.yaml
34+
nof ./examples/find.yaml
3435
```
3536

3637
## Installation
3738

3839
1. Clone the repo:
3940

4041
```
41-
git clone https://github.com/yourusername/nof.git
42+
git clone https://github.com/hosmir/nof.git
4243
cd nof
4344
```
4445

4546
2. Build the binary (requires Go):
4647

4748
```
48-
go build -o nof
49+
go build -o ./bin/ -v ./...
4950
```
5051

52+
OR
53+
54+
Just download the binary from the [releases](/releases) page and add it to your PATH. (The binary is built on for linux amd64)
55+
5156
## Usage
5257

5358
```

examples/find.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
find:
22
- "/var/log"
3-
- "\"*.log\""
3+
- "*.log"
44
- "-mtime"
55
- "-3"

0 commit comments

Comments
 (0)