forked from DebaucheryLibrarian/traxxx
Fixed and documented entity configuration and query.
This commit is contained in:
32
README.md
32
README.md
@@ -18,6 +18,38 @@ Do not modify `config/default.js`, but instead create a copy at `config/local.js
|
||||
|
||||
You can also use `npm run flush` to run both steps at once, and wipe the database completely later.
|
||||
|
||||
#### Networks and channels
|
||||
To scrape the networks and channels available in the database, you can configure `include` and `exclude` lists. To include all available channels and only use the `exclude` list, leave the `include` parameter unconfigured. The `exclude` lists will exclude channels and child networks from networks on the `include` lists, but not vice versa. That is, if the `include` list includes a network and the `exclude` list excludes one of that network's channels, the channel will not be scraped. However, if the `include` list includes a channel, and the `exclude` list includes its parent network, the channel will be scraped.
|
||||
|
||||
This configuration will scrape Evil Angel and all XEmpire channels, except for LesbianX.
|
||||
```
|
||||
include: {
|
||||
networks: [
|
||||
'xempire',
|
||||
],
|
||||
channels: [
|
||||
'evilangel',
|
||||
],
|
||||
},
|
||||
exclude: {
|
||||
channels: [
|
||||
'lesbianx',
|
||||
],
|
||||
}
|
||||
```
|
||||
|
||||
This configuration will scrape all channels, except for BAM Visions, and except all channels part of the Vixen network.
|
||||
```
|
||||
exclude: {
|
||||
channels: [
|
||||
'bamvisions',
|
||||
],
|
||||
networks: [
|
||||
'vixen'
|
||||
],
|
||||
},
|
||||
```
|
||||
|
||||
### Building
|
||||
To build traxxx, run the following command:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user