From 7e672b1e4147936ee615db404f4dd95c3d177039 Mon Sep 17 00:00:00 2001 From: Amy Parker Date: Tue, 8 Aug 2023 15:09:27 -0700 Subject: [PATCH] readme: update instructions, badges This patch updates the configuration, installation, and contribution instructions to reference the docs. It also improves the shields. Signed-off-by: Amy Parker --- README.md | 29 +++++++++-------------------- 1 file changed, 9 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index d8c2a2c..df923db 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@

ssvp: the server statistics viewer project

- -![GitHub](https://img.shields.io/github/license/amyipdev/ssvp) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/amyipdev/ssvp) + +[![GitHub](https://img.shields.io/github/license/amyipdev/ssvp)](https://www.gnu.org/licenses/agpl-3.0.en.html) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/amyipdev/ssvp) [![Static Badge](https://img.shields.io/badge/documentation-ssvp.docs.amyip.net-blue?link=https%3A%2F%2Fssvp.docs.amyip.net%2Findex.html)](https://ssvp.docs.amyip.net)
@@ -20,14 +20,15 @@ The main thing that differs SSVP from other status pages is that it's designed f ## Installation -Clone the repostiory: +**Full installation guide**: https://ssvp.docs.amyip.net/installing.html + +- Clone the repostiory: ```sh git clone --depth=1 https://github.com/amyipdev/ssvp ``` -Install a database software (mysql or postgres) -> If you can't, and just want to test out SSVP, use the `sqlite3` database type +- Set up a database service (sqlite3, mysql, mariadb, or postgres) Run the installer: ```sh @@ -35,18 +36,10 @@ cd ssvp ./install.sh ``` -Set up a cron job by inserting the following line (edit with `crontab -e`): -```cronexp -*/5 * * * * /path/to/ssvp/venv/bin/python3 /path/to/ssvp/srv/interval.py -``` - -Open up a `tmux` session, source the venv (`source venv/bin/activate`), and run either: - -- Development server: `python3 srv/app.py` -- Production server: `srv/gunicorn.sh` - ## Configuration +**Full configuration guide**: https://ssvp.docs.amyip.net/configuration.html + ### WSGI Server If you're setting up a low-usage instance, you can use the dev/Werkezurg instance at `srv/app.py`. However, in production, we recommend using Gunicorn (`srv/gunicorn.sh`) @@ -71,11 +64,7 @@ You should specify the port for SSVP to run on. If you don't specify a port, it' ## Contributing -There are two main ways you can help contribute to SSVP: -1. Use SSVP, and report any bugs you find in Issues. -2. Fix bugs and implement new features via PRs. - -More detailed contribution instructions will be available at a later time. +Please view our contributer guide: https://ssvp.docs.amyip.net/contributing.html ## Limitations and Future Features