bump version + add release guides

Cargo.lock

@@ -2177,7 +2177,7 @@ dependencies = [
 
 [[package]]
 name = "pslink"
-version = "0.3.0"
+version = "0.3.1"
 dependencies = [
  "actix-identity",
  "actix-slog",

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "pslink"
-version = "0.3.0"
+version = "0.3.1"
 description = "A simple webservice that allows registered users to create short links including qr-codes.\nAnyone can visit the shortened links. This is an ideal setup for small busines or for publishing papers."
 authors = ["Dietrich <dietrich@teilgedanken.de>"]
 edition = "2018"

README.md

@@ -6,39 +6,87 @@ So in general this is more a shared short url bookmark webpage than a shorturl s
 
 ![Screenshot](./doc/img/pslinkscreenshot.png)
 
-The Page comes with a basic commandline interface to setup the environment. If it is built with `cargo build release --target=x86_64-unknown-linux-musl` everything is embedded and it should be portable to any 64bit linux system.
+The Page comes with a basic commandline interface to setup the environment.
-Templates and migrations are embedded in the binary. So it should run standalone without anything extra.
 
-## usage
+## Usage
 
-### setup
+### install binary
+
+The pslink binary can be downloaded from the latest release at: https://github.com/enaut/pslink/releases
+
+These binaries are selfcontained and should run on any linux 64bit system. Just put them where you like them to be and make them executable. A sample install might be:
+
+```bash
+# mkdir -p /opt/pslink
+# wget -o /opt/pslink/pslink https://github.com/enaut/pslink/releases/latest/download/pslink.linux.64bit
+# chmod +x /opt/pslink/pslink
+```
+
+You could now adjust your `PATH` or setup an alias or just call the binary with the full path `/opt/pslink/pslink`
+
+### Install with cargo
+
+Pslink can be compiled and installed with cargo. Setup cargo as guided here: https://doc.rust-lang.org/cargo/getting-started/installation.html
+
+After that install pslink using:
+
+```bash
+$ cargo install pslink
+```
+
+If that succeeds you should now be able to call pslink.
+
+### Build from source
+
+When building manually with cargo you have to have a sqlite database present or build it in offline mode. So on your first build you will most likely need to call:
+
+```bash
+SQLX_OFFLINE=1 cargo run
+# or
+$ export SQLX_OFFLINE=1
+$ cargo run
+```
+
+If pslink is built with `cargo build release --target=x86_64-unknown-linux-musl` everything is embedded and it should be portable to any 64bit linux system.
+Templates and migrations are embedded in the binary so it should run standalone without anything extra.
+
+### Setup
 
 To get Pslink up and running use the commands in the following order:
 
-1. `pslink generate-env` this will generate a `.env` file in the curent directory with the default settings. Edit this file to your liking. You can however skip this step and provide all the parameters via commandline or environmentvariable. It is **not** recommended to provide PSLINK_SECRET with commandline parameters as they can be read by every user on the system.
+1. `pslink generate-env`
-2. `pslink migrate-database` will create a sqlite database in the location specified.
-3. `pslink create-admin` create an initial admin user. As the page has no "register" function this is required to do anything usefull.
-4. `pslink runserver` If everything is set up correctly this command will start the service.
 
-### run the service
+    this will generate a `.env` file in the curent directory with the default settings. Edit this file to your liking. You can however skip this step and provide all the parameters via commandline or environmentvariable. It is **not** recommended to provide PSLINK_SECRET with commandline parameters as they can be read by every user on the system.
+2. `pslink migrate-database`
+
+    will create a sqlite database in the location specified.
+3. `pslink create-admin`
+
+    create an initial admin user. As the page has no "register" function this is required to do anything usefull.
+4. `pslink runserver`
+
+    If everything is set up correctly this command will start the service.
+
+### Run the service
 
 If everything is correctly set up just do `pslink runserver`.
 
-### update
+### Update
 
 To update to a newer version execute the commands in the following order
 
 1. stop the service
-2. run `pslink migrate-database`
+2. download and install the new binary
-3. run the server again `pslink runserver`
+3. run `pslink migrate-database`
+4. run the server again `pslink runserver`
 
-### help
+### Help
 
-For a list of options use `pslink help`.
+For a list of options use `pslink help`. If the help does not provide enough clues please file an issue at: https://github.com/enaut/pslink/issues/new
 
-### systemd service file
+### Systemd service file
 
-If you want to automatically start this with systemd you can adjust the following template unit to your system. In this case a dedicated `pslink` user and group are used with the users home directory at `/var/pslink`. Some additional settings are in place to protect the system a little should anything go wrong.
+If you want to automatically start this with systemd you can adjust the following template unit to your system. In this case a dedicated `pslink` user and group is used with the users home directory at `/var/pslink`. Some additional settings are in place to protect the system a little should anything go wrong.
 
 ```systemd
 # /etc/systemd/system/pslink.service

Release.md

@@ -0,0 +1,18 @@
+Guide to release:
+
+ - [ ] Verify everything is committed 
+ - [ ] update the sqlx cache: cargo sqlx prepare
+ - [ ] commit the update
+ - [ ] push to github and teilgedanken
+ - [ ] create release draft tag: https://github.com/enaut/pslink/releases
+ - [ ] verify everything is ready for publishing using:
+ 
+    ```
+    SQLX_OFFLINE=1 cargo publish --dry-run
+    ```
+
+ - [ ] make draft a release
+
+ - [ ] publish 
+ 
+    ```SQLX_OFFLINE=1 cargo publish```