File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -31,6 +31,7 @@ The Handbook
3131.. toctree ::
3232 :maxdepth: 2
3333
34+ installation
3435 introduction
3536 jobs
3637 filters
Original file line number Diff line number Diff line change 1+ .. _installation :
2+
3+ Installation
4+ ============
5+
6+ For prerequisites and optional dependencies, see :doc: `dependencies `.
7+
8+ Install or upgrade with pip
9+ ---------------------------
10+
11+ Use this command for both first-time installs and upgrades:
12+
13+ .. code-block :: bash
14+
15+ python -m pip install --upgrade urlwatch
16+
17+ Verify the installation
18+ -----------------------
19+
20+ Check that urlwatch is on your ``PATH `` and prints a version number:
21+
22+ .. code-block :: bash
23+
24+ urlwatch --version
25+
26+ Next steps
27+ ----------
28+
29+ Continue with :doc: `introduction ` for the Quick Start and initial
30+ configuration.
Original file line number Diff line number Diff line change @@ -7,6 +7,8 @@ Introduction
77Quick Start
88-----------
99
10+ First, install urlwatch by following :doc: `installation `. Once installed:
11+
10121. Run ``urlwatch `` once to migrate your old data or start fresh
11132. Use ``urlwatch --edit `` to customize jobs and filters (``urls.yaml ``)
12143. Use ``urlwatch --edit-config `` to customize settings and reporters (``urlwatch.yaml ``)
You can’t perform that action at this time.
0 commit comments