Write Readme

README.md

-# Welwitschi-Auth
\ No newline at end of file
+# Welwitschi-Auth
+
+Welwitschi-Auth is an authentication library for use in websites written in
+PHP. It offers an object-oriented abstraction over rows stored in a
+MySQL/MariaDB database.
+
+Accounts created by this library all receive a unique ID in the database.
+Usernames and email addresses are also unique, it is not possible to have
+duplicate entries.
+
+Upon creation of an account, the account will need to be confirmed before
+being able to log in or generate API keys.
+
+A user is able to log in with exactly one device at a time, as well as have
+one active API token.
+
+## Security
+
+Passwords, API Tokens and Login Tokens are all stored salted and hashed
+using the builtin `password_hash()` function. The algorithm used to hash the
+password is `PASSWORD_BCRYPT`.
+
+All SQL Statements with variable values are properly escaped to avoid SQL
+injection.
+
+Usernames and Email addresses are sanitized using html `htmlspecialchars` to
+avoid Cross-Site-Scripting attacks (XSS).
+
+## Installation
+
+You can use welwitschi-auth by adding the requirement
+
+    "namboy94/welwitschi-auth": "dev-master"
+    
+to your `composer.json` file an then running `composer install`. You can then
+find the classes in `vendor/namboy94/welwitschi-auth/src`.
+
+## Further Information
+
+* [Changelog](https://gitlab.namibsun.net/namboy94/welwitschi-auth/raw/master/CHANGELOG)
+* [Gitlab](https://gitlab.namibsun.net/namboy94/welwitschi-auth)
+* [Github](https://github.com/namboy94/welwitschi-auth)
+* [Packagist Page](https://packagist.org/packages/namboy94/welwitschi-auth)
+* [Git Statistics (gitstats)](https://gitstats.namibsun.net/gitstats/welwitschi-auth/index.html)
+* [Git Statistics (git_stats)](https://gitstats.namibsun.net/git_stats/welwitschi-auth/index.html)
+* [Test Coverage](https://coverage.namibsun.net/welwitschi-auth/index.html)

composer.json

@@ -14,7 +14,8 @@
     }
   ],
   "require": {
-    "php": ">=7.1.0"
+    "php": ">=7.1.0",
+    "ext-mysqli" : "*"
   },
   "require-dev": {
     "phpunit/phpunit": "*"

src/User.php

@@ -176,7 +176,7 @@ class User {
 	 * @return string: The generated API key.
 	 *                 null if the user is not confirmed yet
 	 */
-	public function generateNewApiKey() : ?string {
+	public function generateNewApiKey() : ? string {
 
 		if ($this->confirmed) {
 			$apiKey = bin2hex(random_bytes(64));