Add README & LICENSE

README.md

@@ -1,4 +1,34 @@
 # Basic OIDC
-Basic OpenID provider. Still under early development.
+Basic & lightweight OpenID provider. Supports the `authorization_code` flow, written in Rust. 
 
-Official OpenID specifications: https://openid.net/developers/specs/
+**WARNING :** This tool has not been audited, use it at your own risks!
+
+BasicOIDC operates without any database, just with two files :
+* `clients.yaml`: a list of authorized relying parties.
+* `users.json`: a list of users, managed through a web UI.
+
+You can configure a list of clients (Relying Parties) in a `clients.yaml` file with the following syntax :
+```yaml
+- id: gitea
+  name: Gitea
+  description: Git with a cup of tea
+  secret: TOP_SECRET
+  redirect_uri: https://mygit.mywebsite.com/
+```
+
+On the first run, BasicOIDC will create a new administrator with credentials `admin` / `admin`. On first login you will have to change these default credentials.
+
+In order to run BasicOIDC for development, you will need to create a least an empty `clients.yaml` file inside the storage directory.
+
+Features :
+* [x] Bruteforce protection
+* [ ] 2 factors authentication
+
+## Compiling
+You will need the Rust toolchain to compile this project. To build it for production, just run:
+```bash
+cargo build --release
+```
+
+## Contributing
+If you wish to contribute to this software, feel free to send an email to contact@communiquons.org to get an account on my system, managed by BasicOIDC :)