Skip to content

Commit 3665c3a

Browse files
committed
chore: update readme
1 parent 38fdb38 commit 3665c3a

1 file changed

Lines changed: 5 additions & 10 deletions

File tree

README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,16 @@
1414

1515
<br />
1616

17-
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.
17+
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 supports all the popular proxies like Traefik, Nginx and Caddy.
1818

1919
![Screenshot](assets/screenshot.png)
2020

2121
> [!WARNING]
2222
> Tinyauth is in active development and configuration may change often. Please make sure to carefully read the release notes before updating.
2323
24-
> [!NOTE]
25-
> 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.
26-
2724
## Getting Started
2825

29-
You can easily get started with tinyauth by following the guide in the [documentation](https://tinyauth.app/docs/getting-started.html). There is also an available [docker compose file](./docker-compose.example.yml) that has traefik, whoami and tinyauth to demonstrate its capabilities.
26+
You can easily get started with tinyauth by following the guide in the [documentation](https://tinyauth.app/docs/getting-started.html). There is also an available [docker compose](./docker-compose.example.yml) file that has traefik, whoami and tinyauth to demonstrate its capabilities.
3027

3128
## Demo
3229

@@ -38,15 +35,15 @@ You can find documentation and guides on all of the available configuration of t
3835

3936
## Discord
4037

41-
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).
38+
Tinyauth has a [discord](https://discord.gg/eHzVaCzRRd) server. Feel free to hop in to chat about self-hosting, homelabs and of course tinyauth. See you there!
4239

4340
## Contributing
4441

45-
All contributions to the codebase are welcome! If you have any recommendations on how to improve security or find a security issue in tinyauth please open an issue or pull request so it can be fixed as soon as possible!
42+
All contributions to the codebase are welcome! If you have any free time feel free to pick up an [Issue](https://github.com/steveiliop56/tinyauth/issues) or add your own missing features. Make sure to check out the [contributing guide](./CONTRIBUTING.md) for instructions on how to get the development server up and running.
4643

4744
## Localization
4845

49-
If you would like to help translating the project in more languages you can do so by visiting the [Crowdin](https://crowdin.com/project/tinyauth) page.
46+
If you would like to help translating tinyauth into more languages, visit the [Crowdin](https://crowdin.com/project/tinyauth) page.
5047

5148
## License
5249

@@ -60,8 +57,6 @@ Thanks a lot to the following people for providing me with more coffee:
6057

6158
## Acknowledgements
6259

63-
Credits for the logo of this app go to:
64-
6560
- **Freepik** for providing the police hat and badge.
6661
- **Renee French** for the original gopher logo.
6762
- **Coderabbit AI** for providing free AI code reviews.

0 commit comments

Comments
 (0)