Skip to content

Commit 67866ba

Browse files
authored
Add quickstart and improve description
1 parent 66d5534 commit 67866ba

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed

README.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,40 @@
44
55
Tree query is a tool that searches across indented lines.
66

7-
It is a replacement for Roam's query system.
7+
It is a replacement for Roam's query system. It supports everything Roam does, except for block references.
88

9-
## Command-line usage
9+
## Quickstart
1010

11-
`tree-query '{and: [[Hello]] [[Hi]]}' file1 file2 folder1 folder2`
11+
**Query in current directory:**
12+
```
13+
tree-query '{and: [[Page 1]] [[Page 2]]}' .
14+
```
15+
[*Learn to navigate to a working directory with `cd`*](https://linuxize.com/post/linux-cd-command/)
16+
17+
**Query in a folder:**
18+
19+
```
20+
tree-query '{and: [[Page 1]] [[Page 2]]}' /Users/steve/myfoldername/
21+
```
22+
*Learn to get the location of a folder on [macOS](https://osxdaily.com/2009/11/23/copy-a-files-path-to-the-terminal-by-dragging-and-dropping/), [Windows](https://www.top-password.com/blog/copy-full-path-of-a-folder-file-in-windows/), or [GNU+Linux](https://unix.stackexchange.com/questions/102551/mouse-shortcut-to-copy-the-path-to-a-file-in-the-gnome-file-manager).*
23+
24+
**Query in a group of folders and files:**
25+
26+
```
27+
tree-query '{and: [[Page 1]] [[Page 2]]}' /Users/steve/myfoldername/ file1
28+
```
29+
30+
**Query stdin:**
31+
32+
```
33+
cat myfile | tree-query '{and: [[Page 1]] [[Page 2]]}'
34+
```
1235

1336
## Features
1437

1538
This section is a work-in-progress.
1639

17-
* **Fast**: Over 880Mbps on a MacBook Air
40+
* **Fast**
1841

1942
## Contributing
2043

0 commit comments

Comments
 (0)