Rename: to Qvisqve

1 files changed, 33 insertions, 23 deletions

diff --git a/README b/README
index 5c624ed..56347de 100644
--- a/README
+++ b/README
@@ -1,58 +1,68 @@
-README for Salami
+README for Qvisqve
 =============================================================================
 
-This is identity provider; specifically, an OAuth2 authentication
-server. Originally developed to help development of Qvarn
-(<http://qvarn.org>). It currently supports only the **client
-credentials** grant. Later on, we hope to develop this into an OpenID
-Connect provider.
+This is an authorisation server and identity provider. Specifically,
+it implements the OAuth2 client credentials grant. Originally
+developed to help development of Qvarn (<http://qvarn.org>). Later on,
+we hope to develop this into an OpenID Connect provider with support
+for authenticating end users.
 
 
 Configuration for testing
 -----------------------------------------------------------------------------
 
-The `debug.yaml` file contains a sample configuration file for Salami
-for debugging and light testing. Use it with the `start_salami`
+The `debug.yaml` file contains a sample configuration file for Qvisqve
+for debugging and light testing. Use it with the `start_qvisqve`
 script.
 
 The config defines one API client, client id `test-client`, with a
 client secret of "hunter2".
 
 
-Running Salami for debugging
+Requirements
+-----------------------------------------------------------------------------
+
+The target environment is currently Debian stretch with
+stretch-backports enabled. The software might work elsewhere,
+especially later versions of Debian.
+
+You'll want to have Python 3.5 or later.
+
+
+Running Qvisqve for debugging
 -----------------------------------------------------------------------------
 
 At the root of the source tree, run the following:
 
-    ./start_salami debug.yaml
+    ./start_qvisqve debug.yaml
 
-This starts Salami using the Bottle.py built-in debug HTTP server,
-instead of gunicorn. This makes it easier to debug Salami. If you'd
-like to run it with gunicorn instead, add the following line to
+This starts Qvisqve using the Bottle.py built-in debug HTTP server,
+instead of gunicorn. This makes it easier to debug the server. If
+you'd like to run it with gunicorn instead, add the following line to
 `debug.yaml`:
 
     gunicorn: yes
 
 Then run this:
 
-    ./start_salami debug.yaml
+    ./start_qvisqve debug.yaml
 
-This runs Salami with gunicorn. Note that that means it is run in the
-background. You will need to kill the process manually.
+This runs the server with gunicorn. Note that that means it is run in
+the background. You will need to kill the process manually.
 
 
-Running Salami for production
+Running Qvisqve for production
 -----------------------------------------------------------------------------
 
-Install Salami and then run:
+Install Qvisqve and then run:
 
-    start_salami /etc/salamia/salami.yaml
+    start_qvirqve /etc/qvisqve/qvisqve.yaml
 
-This runs Salami using gunicorn. Better, install the `salami.service`
-systemd unit and start Salami with that.
+This runs Qvisqve using gunicorn. Better, install the `qvisqve.service`
+systemd unit and start Qvisqve with that.
 
 
-Merging workflow
+Git merging workflow for development
 -----------------------------------------------------------------------------
 
 All development will happen on branches other than master. Changes are
@@ -116,7 +126,7 @@ Legalese
 Qvarn in its entirety is copyright by its authorss, and released under
 the GNU Affero General Public Licence, version 3, or later.
 
-    Salami - an identity provider
+    Qvisqve - an authorisation server and an identity provider
     Copyright (C) 2018  Lars Wirzenius
 
     This program is free software: you can redistribute it and/or modify