Adding a readme to all crates/subdirectory of this workspace

app/README.md

@@ -0,0 +1,11 @@
+# The Frontend for pslink
+
+This part of `pslink` is the wasm binary for the frontend of `pslink`.
+
+It provides:
+  * a login screen
+  * management for links
+  * management for  users
+  * switching the language
+
+The wasm binary communicates via a REST-JSON-Api with the server.

doc/img/README.md

@@ -0,0 +1 @@
+Files that are used in documentation throughout the workspace.

locales/README.md

@@ -0,0 +1,8 @@
+# Translations
+
+In this directory all the translations are stored. They are formatted in the [fluent language](https://projectfluent.org/)
+
+To add a new language several places need updating. A probably incomplete list:
+
+  * copying and renaming one of the directories here
+  * update `app/navigation.rs` and `app/i18n.rs`

pslink/README.md

@@ -0,0 +1,16 @@
+# The pslink library and binary
+
+This is the pslink server part. It provides a webserver to be run behind another webserver like apache or nginx. Everything needed to run is bundled in the pslink binary. So you can compile everything locally and the copy the single binary to your server and run it.
+
+Library features:
+  * models for writing and retriving information from the database
+
+Server/Binary features:
+  * creation and migration of the database
+  * creating an admin user
+  * creating a `.env` file with all available options
+  * launch the server
+    * serve the wasm-file
+    * serve styling and js bindings
+    * provide a REST-JSON-Api to get and modify entries in the database
+    * authentication

pslink/locales/de/main.ftl

@@ -1,36 +0,0 @@
-list-links = Link Liste
-add-link = Link hinzufügen
-invite-user = Benutzer einladen
-list-users = Liste der Benutzer
-welcome-user = Herzlich willkommen {$username}
-logout = Abmelden
-login = Login
-
-not-found = Dieser Link existiert nicht, oder wurde gelöscht.
-
-edit-link-headline = Zu editierender Link: {$linktitle}
-edit-link = Link Editieren
-link-description = Beschreibung
-link-target = Link Ziel
-link-code = Link Code
-shortlink = Shortlink
-qr-code = QR-code
-
-danger-zone = Achtung!
-danger-zone-text = Verändern Sie den Code von bereits veröffentlichten Links nicht. Sollte es dennoch geschehen werden veröffentlichte links unbenutzbar. Wird das Linkziel verändert, so zeigen auch die bereits veröffentlichten Links auf das neue Ziel.
-
-save-edits = Speichere die Veränderungen
-delete-link = Diesen Link löschen
-
-edit-user-headline = Benutzereinstellungen von: {$username}
-username = Benutzername
-email = Email
-password = Passwort
-password-placeholder = Leer lassen um das Passwort nicht zu ändern
-save-user = Benutzer speichern
-edit-user = Benutzer editieren
-make-user-admin = Zum Administrator befördern
-make-user-regular = Zurückstufen zum normalen Nutzer
-
-userid = Benutzernummer
-statistics = Statistik

pslink/locales/en/main.ftl

@@ -1,36 +0,0 @@
-list-links = List of existing links
-add-link = Add a new link
-invite-user = Invite a new user
-list-users = List of existing users
-welcome-user = Welcome {$username}
-logout = Logout
-login = Login
-
-not-found = This Link has not been found or has been deleted
-
-edit-link-headline = Edit link: {$linktitle}
-edit-link = Edit link
-link-description = Description
-link-target = Link target
-link-code = Link code
-shortlink = Shortlink
-
-danger-zone = Danger Zone!
-danger-zone-text = Do not change the code of links that are published. If you do so the published links will become invalid! If you change the target the published links will point to the new target.
-
-save-edits = Save edits
-delete-link = Delete this link
-
-user-headline = User Settings of: {$username}
-edit-user-headline = Change Settings of: {$username}
-username = Username
-email = Email
-password = Password
-password-placeholder = Leave this empty to keep the current password
-save-user = Save this user
-edit-user = Edit this user
-make-user-admin = Promote to admin
-make-user-regular = Demote to regular
-
-userid = User ID
-statistics = Statistics

shared/README.md

@@ -0,0 +1 @@
+A collection of datatypes and related functionality that is used in the wasm aswell as in the pslink binary.