Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jackdoe committed Apr 18, 2020
1 parent a66023a commit 628eefe
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ or
(bloom search was very interesting, but it needs at least two
terms to make sense, which is super annoying)
* add sharding
* zr-fetch - a way to download public indexes

# What is it?

Expand Down Expand Up @@ -114,11 +115,23 @@ $ go install github.com/jackdoe/zr/cmd/zr-stdin
$ go install github.com/jackdoe/zr/cmd/zr-reindex
$ go install github.com/jackdoe/zr/cmd/zr-fetch

or you can download the binary from releases/

# Download the public index
Index I build and publish, it includes man pages and RFC
You can download and use the public index I build and publish, it
includes man pages and RFC

$ zr-fetch

This is the equivalent of:
cat << EOF | zr-fetch -list -
public/man https://txt.black/~jack/zr-public/man.tar.gz
public/rfc https://txt.black/~jack/zr-public/rfc.tar.gz
EOF

By default it reads https://raw.githubusercontent.com/jackdoe/zr/master/public.txt
but you can specify any url or - for stdin

$ zr -k public/man printf
$ zr -k public/rfc tcp

Expand Down

0 comments on commit 628eefe

Please sign in to comment.