diff --git a/README.md b/README.md index af3f10c..4898404 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@
- Tinyauth + Tinyauth

Tinyauth

The easiest way to secure your apps with a login screen.

@@ -15,19 +15,19 @@
-Tinyauth is a simple authentication middleware that adds simple username/password login or OAuth with Google, Github and any generic provider to all of your docker apps. It is designed for traefik but it can be extended to work with all reverse proxies like caddy and nginx. +Tinyauth is a simple authentication middleware that adds simple username/password login or OAuth with Google, Github and any generic provider to all of your docker apps. It is designed for traefik but it can be extended to work with other reverse proxies like caddy and nginx. -![Login](assets/screenshot.png) +![Screenshot](docs/screenshot.png) > [!WARNING] > Tinyauth is in active development and configuration may change often. Please make sure to carefully read the release notes before updating. > [!NOTE] -> Tinyauth is intended for homelab use and it is not made for production use cases. If you are looking for something production ready please use [authentik](https://goauthentik.io). +> Tinyauth is intended for homelab use only and it is not made for production use cases. If you are looking for something production ready please use [authentik](https://goauthentik.io) instead. ## Discord -I just made a Discord server for Tinyauth! It is not only for Tinyauth but general self-hosting because I just like chatting with people! The link is [here](https://discord.gg/eHzVaCzRRd), see you there! +I just made a Discord server for tinyauth! It is not only for tinyauth but general self-hosting and homelabbing. [See you there!](https://discord.gg/eHzVaCzRRd). ## Getting Started @@ -35,7 +35,7 @@ You can easily get started with tinyauth by following the guide in the [document ## Documentation -You can find documentation and guides on all of the available configuration of tinyauth [here](https://tinyauth.app). +You can find documentation and guides on all of the available configuration of tinyauth in the [website](https://tinyauth.app). ## Contributing @@ -53,9 +53,7 @@ Tinyauth is licensed under the GNU General Public License v3.0. TL;DR — You ma Thanks a lot to the following people for providing me with more coffee: -|
Nicolas
|
Erwin
|
SimpleHomelab
|
jmadden91
| -| -------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -|
Nicolas
|
Erwin
|
SimpleHomelab
|
jmadden91
| +User avatar: erwinkramer  User avatar: nicotsx  User avatar: SimpleHomelab  User avatar: jmadden91  User avatar: tribor  User avatar: eliasbenb   ## Acknowledgements @@ -63,6 +61,7 @@ Credits for the logo of this app go to: - **Freepik** for providing the police hat and badge. - **Renee French** for the original gopher logo. +- **Coderabbit AI** for providing free AI code reviews. ## Star History diff --git a/assets/screenshot.png b/assets/screenshot.png deleted file mode 100644 index 4879f42..0000000 Binary files a/assets/screenshot.png and /dev/null differ diff --git a/assets/discohook.json b/docs/discohook.json similarity index 100% rename from assets/discohook.json rename to docs/discohook.json diff --git a/docs/logo-rounded.png b/docs/logo-rounded.png new file mode 100644 index 0000000..146ee78 Binary files /dev/null and b/docs/logo-rounded.png differ diff --git a/docs/logo-solid.jpg b/docs/logo-solid.jpg new file mode 100644 index 0000000..f9b05b9 Binary files /dev/null and b/docs/logo-solid.jpg differ diff --git a/docs/logo.png b/docs/logo.png new file mode 100644 index 0000000..d80e877 Binary files /dev/null and b/docs/logo.png differ diff --git a/assets/logo.xcf b/docs/logo.xcf similarity index 100% rename from assets/logo.xcf rename to docs/logo.xcf diff --git a/docs/screenshot.png b/docs/screenshot.png new file mode 100644 index 0000000..644ad7d Binary files /dev/null and b/docs/screenshot.png differ