Added basic setup instructions to README.
This commit is contained in:
parent
4464943dd9
commit
9ab9e11b96
23
README.md
23
README.md
|
@ -1,6 +1,29 @@
|
|||
# Traxxx
|
||||
The latest releases from your favorite porn studios in one place.
|
||||
|
||||
## Install & run
|
||||
Use [nvm](https://github.com/creationix/nvm) to install a recent version of NodeJS.
|
||||
|
||||
`npm install`
|
||||
`npm run seed`
|
||||
|
||||
`npm start`
|
||||
|
||||
### Configuration
|
||||
Do not modify `config/default.js`, but instead create a copy at `config/local.js` containing the properties you wish to change.
|
||||
|
||||
### Options
|
||||
* `--site [side ID]`: Only show updates from a specific site. The site ID is typically the site name in lowercase and without cases or special characters. For example, Teens Like It Big is teenslikeitbig.
|
||||
* `--network [network ID]`: Show updates from all sites of a specific network. The network ID is composed similarly to the site ID.
|
||||
* `--after "[time]"`: Do not fetch scenes older than this. Example values are: `"1 month"`, `"2 weeks"`, `"3 years"`.
|
||||
* `--scene [URL]`: Try to retrieve scene details from its official site or network URL.
|
||||
* `--copy`: Try to copy relevant results to the clipboard. When used with `--scene`, it will copy the filename as defined in the config with all the details filled in.
|
||||
|
||||
#### Developer options
|
||||
* `--no-render`: Fetch data, but don't render it to GUI screen.
|
||||
* `--no-save`: Do not store retrieved information in local database, forcing re-fetch.
|
||||
* `--debug`: Show full error stack trace.
|
||||
|
||||
## Supported networks & sites
|
||||
233 sites on 14 networks
|
||||
* **21Sextury**
|
||||
|
|
Loading…
Reference in New Issue