Skip to content

Commit 55c33f7

Browse files
committed
chore: update readme
1 parent b6eb902 commit 55c33f7

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<div align="center">
22
<img alt="Tinyauth" title="Tinyauth" width="96" src="assets/logo-rounded.png">
33
<h1>Tinyauth</h1>
4-
<p>The simplest way to protect your apps with a login screen.</p>
4+
<p>The tiniest authentication and authorization server you have ever seen.</p>
55
</div>
66

77
<div align="center">
@@ -14,7 +14,7 @@
1414

1515
<br />
1616

17-
Tinyauth is a simple authentication middleware that adds a simple login screen or OAuth with Google, Github or any other provider to all of your apps. It supports all the popular proxies like Traefik, Nginx and Caddy.
17+
Tinyauth is the simplest and tiniest authentication and authorization server you have ever seen. It is designed to both work as an authentication middleware for your apps, offering support for OAuth, LDAP and access-controls, and as a standalone authentication server. It supports all the popular proxies like Traefik, Nginx and Caddy.
1818

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

@@ -26,7 +26,7 @@ Tinyauth is a simple authentication middleware that adds a simple login screen o
2626
2727
## Getting Started
2828

29-
You can easily get started with Tinyauth by following the guide in the [documentation](https://tinyauth.app/docs/getting-started). There is also an available [docker compose](./docker-compose.example.yml) file that has Traefik, Whoami and Tinyauth to demonstrate its capabilities.
29+
You can get started with Tinyauth by following the guide in the [documentation](https://tinyauth.app/docs/getting-started). There is also an available [docker-compose](./docker-compose.example.yml) file that has Traefik, Whoami and Tinyauth to demonstrate its capabilities (keep in mind that this file lives in the development branch so it may have updates that are not yet released).
3030

3131
## Demo
3232

@@ -40,15 +40,15 @@ If you wish to contribute to the documentation head over to the [repository](htt
4040

4141
## Discord
4242

43-
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!
43+
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!
4444

4545
## Contributing
4646

47-
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.
47+
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.
4848

4949
## Localization
5050

51-
If you would like to help translate Tinyauth into more languages, visit the [Crowdin](https://crowdin.com/project/tinyauth) page.
51+
If you like, you can help translate Tinyauth into more languages by visiting the [Crowdin](https://crowdin.com/project/tinyauth) page.
5252

5353
## License
5454

0 commit comments

Comments
 (0)