diff --git a/README.md b/README.md index eb496c53..786704ed 100644 --- a/README.md +++ b/README.md @@ -18,14 +18,16 @@ Do not modify `config/default.js`, but instead create a copy at `config/local.js ### Options `npm start -- --option value` -* `--site [site 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. +To run the web server, run `npm start` without any arguments. + +* `--site [site ID]`: Fetch 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]`: Fetch 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. +* `--deep`: Follow each release link found running `--site` or `--network` and scrape it for more details. Enabled by default at the moment of writing; use `--no-deep` to only save information found on the overview pages. * `--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.