diff --git a/README.md b/README.md
index 2f2de84..56512c5 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,31 @@
# Table of Contents
-1. [ldap0r](#org5453f05)
- 1. [Installation](#org225ba27)
- 2. [Todo List](#org54f2856)
- 1. [Password reset [5/10]
](#org09786dd)
- 2. [Configuration [0/5]
](#orgb93c7a2)
- 3. [Login Section (not sure if going to happen)](#orga66a23f)
+1. [ldap0r](#orgf56b909)
+ 1. [Installation](#org6f0551a)
+ 2. [Contribution](#org8358327)
+ 3. [Todo List](#orga6f7ebf)
+ 1. [Password reset [5/11]
](#org83950f1)
+ 2. [Configuration [0/5]
](#orgf7ec86e)
+ 3. [Login Section (not sure if going to happen)](#org9f168b0)
-
+
# ldap0r
So far `ldap0r` is simply a very small web application just to reset
-LDAP passwords. An user enters its email address, receives an email
-containing a link to reset its LDAP password, thats it so far.
+LDAP passwords. All it is capable of is to let an user enter its
+email address and send an email containing a generated link to reset
+the LDAP password, that's it so far. My motivation was to have
+something "suckless" which does not depend on PHP or similar insane.
-
+
## Installation
-A rust nightly toolchain which can be aquired via
+A rust nightly toolchain which can be acquired via
is needed in order to successfully build `ldap0r`. Install `rustup`,
download rust nightly, then clone this repository, set the
toolchain inside the source directory to nightly, build and run it.
@@ -37,18 +40,25 @@ The application can be configured with the `Rocket.toml`
configuration file.
-
+
+
+## Contribution
+
+I am open for suggestions and appreciate any feedback.
+
+
+
## Todo List
-
+
-### Password reset [5/10]
+### Password reset [5/11]
-1. DONE Form to send resetlink
+1. DONE Form to send reset link
-2. DONE Parse url with reset key
+2. DONE Parse URL with reset key
3. DONE Cleanup all unwraps
@@ -64,10 +74,12 @@ configuration file.
9. TODO Implement proper tests
-10. TODO Optionaly store key persistently between restarts
+10. TODO Optionally store key persistently between restarts
+
+11. TODO Should `tera` templates instead of `handlebar` templates be used?
-
+
### Configuration [0/5]
@@ -82,6 +94,6 @@ configuration file.
5. TODO Make html/text emails configurable
-
+
### Login Section (not sure if going to happen)
diff --git a/README.org b/README.org
index 8d2965b..4b26e8c 100644
--- a/README.org
+++ b/README.org
@@ -1,10 +1,12 @@
* ldap0r
So far =ldap0r= is simply a very small web application just to reset
- LDAP passwords. An user enters its email address, receives an email
- containing a link to reset its LDAP password, thats it so far.
+ LDAP passwords. All it is capable of is to let an user enter its
+ email address and send an email containing a generated link to reset
+ the LDAP password, that's it so far. My motivation was to have
+ something "suckless" which does not depend on PHP or similar insane.
** Installation
- A rust nightly toolchain which can be aquired via https://rustup.rs
+ A rust nightly toolchain which can be acquired via https://rustup.rs
is needed in order to successfully build =ldap0r=. Install =rustup=,
download rust nightly, then clone this repository, set the
toolchain inside the source directory to nightly, build and run it.
@@ -20,10 +22,13 @@
The application can be configured with the =Rocket.toml=
configuration file.
+** Contribution
+ I am open for suggestions and appreciate any feedback.
+
** Todo List
-*** Password reset [5/10]
-**** DONE Form to send resetlink
-**** DONE Parse url with reset key
+*** Password reset [5/11]
+**** DONE Form to send reset link
+**** DONE Parse URL with reset key
**** DONE Cleanup all unwraps
**** DONE Proper error handling
**** DONE Implement proper logging
@@ -31,7 +36,8 @@
**** TODO Check for existing keys
**** TODO Implement key validity timeout
**** TODO Implement proper tests
-**** TODO Optionaly store key persistently between restarts
+**** TODO Optionally store key persistently between restarts
+**** TODO Should =tera= templates instead of =handlebar= templates be used?
*** Configuration [0/5]
**** TODO Fix domain config