aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFelix Hanley <felix@userspace.com.au>2020-11-08 23:33:08 +0000
committerFelix Hanley <felix@userspace.com.au>2020-11-16 22:07:05 +0000
commit9b72d1065ca106c98b01b62caefdd2cf8f08178c (patch)
tree2adfef8b2f48c80ba23b3df90831766a32ea2d49 /README.md
parenteda2530094e72463f6aef6e7f9bf524002e248fa (diff)
downloaddhtsearch-9b72d1065ca106c98b01b62caefdd2cf8f08178c.tar.gz
dhtsearch-9b72d1065ca106c98b01b62caefdd2cf8f08178c.tar.bz2
Clean up build and docsHEADv1.1.0master
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 8 insertions, 9 deletions
diff --git a/README.md b/README.md
index 70f14af..474d867 100644
--- a/README.md
+++ b/README.md
@@ -24,29 +24,28 @@ hosted by the remote nodes are not retrieved.
- **Filtering** can be done by tags. By default all torrents tagged 'adult' are
not indexed. See the SkipTags option in the configuration file.
-- **Full Text Search** using PostgreSQL's text search vectors. Torrent names
- are weighted more than file names.
+- **Full Text Search** using PostgreSQL's or Sqlite's text search vectors.
+ Torrent names are weighted more than file names.
- **Statistics** for the crawler process are available when the HTTP server is
enabled. Fetch the JSON from the `/status` endpoint.
- **Custom tags** can be defined in the configuration file.
+- **Cross-platform** builds for Windows, Macos, Linux, FreeBSD, and OpenBSD
+
## Installation
-All dependencies have been vendored using the
-[dep](https://github.com/golang/dep) tool so installation with a recent Go
-version should be as simple as:
+There is a Makefile for GNU make:
```shell
-$ go build
+$ make build
```
## Usage
-You will need to create a PostgreSQL database using the `schema.sql` file
-provided. You are going to need to sort out any port forwarding if you are
-behind NAT so remote nodes can get to yours.
+You are going to need to sort out any port forwarding if you are behind NAT so
+remote nodes can get to yours.
Configuration is done via a [TOML](https://github.com/toml-lang/toml) formatted
file or via flags passed to the daemon.