LBRYCommunity/tracker
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity

Bit of info on usage

Browse source 
[ci skip]
This commit is contained in:
Justin Li 2013-08-29 22:02:12 -04:00
parent a9f5420715
commit 6146cc85e3
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -18,6 +18,14 @@ Planned features include:
See [the wiki](https://github.com/pushrax/chihaya/wiki) for a discussion of the design behind Chihaya. See [the wiki](https://github.com/pushrax/chihaya/wiki) for a discussion of the design behind Chihaya.
## Using Chihaya ## Using Chihaya
Chihaya is intended to work with existing torrent indexing web frameworks, such as [batter] and [Gazelle].
Following the Unix way, it is built to perform a specific task, and interface with any system that
needs its functionality. See [below](#drivers) for more info.
[batter]: https://github.com/wafflesfm/batter
[gazelle]: https://github.com/whatcd/gazelle
### Installing ### Installing
Make sure you have your `$GOROOT` and `$GOPATH` set up correctly, and have your `$GOBIN` in your `$PATH`. Make sure you have your `$GOROOT` and `$GOPATH` set up correctly, and have your `$GOBIN` in your `$PATH`.
@ -40,7 +48,7 @@ $ go get github.com/pushrax/chihaya
$ go test -v ./... $ go test -v ./...
``` ```
## Default drivers ## Drivers
Chihaya is designed to remain agnostic about the choice of data store for an Chihaya is designed to remain agnostic about the choice of data store for an
application, and it is straightforward to [implement a new driver]. However, there application, and it is straightforward to [implement a new driver]. However, there