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

Add instructions for how to import custom drivers

Browse source
This commit is contained in:
Justin Li 2014-07-16 19:46:50 -04:00
parent cd6204f13d
commit 019bb449b5
2 changed files with 19 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -61,8 +61,25 @@ Backend:
* noop (for public trackers)
* [gazelle (mysql)](https://github.com/chihaya/chihaya-gazelle)
[implement a new driver]: https://github.com/chihaya/chihaya/wiki/Implementing-a-driver
To use an external driver, make your own package and call it something like `github.com/yourusername/chihaya`. Then, import Chihaya like so:
```go
package chihaya // This is your own chihaya package.
import (
c "github.com/chihaya/chihaya" // Use an alternate name to avoid the conflict.
_ "github.com/yourusername/chihaya-custom-backend" // Import any of your own drivers.
)
func main() {
c.Boot() // Start Chihaya normally.
}
```
Then, when you do `go install github.com/yourusername/chihaya`, your own drivers will be included in the binary.
[implement a new driver]: https://github.com/chihaya/chihaya/wiki/Implementing-a-driver
## Contributing

2
main.go
View file

@ -15,7 +15,7 @@ import (
"github.com/chihaya/chihaya/config"
"github.com/chihaya/chihaya/http"
// All drivers are imported here.
// See the README for how to import custom drivers.
_ "github.com/chihaya/chihaya/drivers/backend/noop"
_ "github.com/chihaya/chihaya/drivers/tracker/memory"
)