Docs

leodip · Nov 30, 2023 · 7d0103c · 7d0103c
1 parent d438da1
commit 7d0103c
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-Goiabada is an open source OAuth2 / OpenID Connect server written in Go.
+Goiabada is an open-source **authentication** and **authorization** server. 
 
 Goiabada provides a solution for user management, allowing application developers to define users, groups, resources and permissions within their software. It also facilitates secure server-to-server interactions.
 
@@ -11,4 +11,4 @@ Goiabada provides a solution for user management, allowing application developer
 - OAuth2 support, including authorization code flow and client credentials flow
 - OpenID Connect support
 
-Documentation: [https://goiabada.dev/](https://goiabada.dev/).
+Documentation: [https://goiabada.dev](https://goiabada.dev).
diff --git a/mkdocs/docs/development.md b/mkdocs/docs/development.md
@@ -8,4 +8,4 @@ For running integration tests, use the `run-tests` script. Test coverage will be
 
 Goiabada uses [GORM](https://gorm.io/) for data access, [Tailwind CSS](https://tailwindcss.com/) with [DaisyUI](https://daisyui.com/) for UI & styling, and the [chi router](https://github.com/go-chi/chi) to manage the incoming HTTP requests.
 
-If you're interested in contributing to the project, don't hesitate to reach out to me at [leo@goiabada.dev](mailto:leo@goiabada.dev), or submit pull requests. Your involvement is welcome and appreciated.
+If you're interested in contributing to the project, don't hesitate to reach out to me at [contact@leodip.com](mailto:contact@leodip.com), or submit pull requests. Your involvement is welcome and appreciated.
diff --git a/mkdocs/docs/how-it-works.md b/mkdocs/docs/how-it-works.md
@@ -97,14 +97,14 @@ Besides the normal authorization scope explained earlier, Goiabada supports typi
 
 | OIDC scope | Description |
 | --------- | ----------- |
-| openid | Will include an **id token** in the token response, with the subject identifier (sub claim) |
-| profile | Access to claims: name, family_name, given_name, middle_name, nickname, preferred_username, profile, website, gender, birthdate, zoneinfo, locale, and updated_at |
-| email | Access to claims: email, email_verified |
-| address | Access to the address claim |
-| phone | Access to claims: phone_number and phone_number_verified |
+| openid | Will include an `id_token` in the token response, with the subject identifier (`sub` claim) |
+| profile | Access to claims: `name`, `family_name`, `given_name`, `middle_name`, `nickname`, `preferred_username`, `profile`, `website`, `gender`, `birthdate`, `zoneinfo`, `locale`, and `updated_at` |
+| email | Access to claims: `email`, `email_verified` |
+| address | Access to the `address` claim |
+| phone | Access to claims: `phone_number` and `phone_number_verified` |
 | groups | Access to the list of groups the user belongs to |
 | attributes | Access to the attributes assigned to the user by an admin, stored as key-value pairs |
-| offline_access | Access to a refresh token of the type 'Offline', allowing the client to obtain a new access token without requiring an immediate interaction |
+| offline_access | Access to a refresh token of the type `Offline`, allowing the client to obtain a new access token without requiring an immediate interaction |
 
 ## User sessions
 

diff --git a/mkdocs/docs/index.md b/mkdocs/docs/index.md
@@ -2,7 +2,7 @@
 
 Goiabada is an open-source **authentication** and **authorization** server. 
 
-Goiabada provides a solution for **user management**, allowing application developers to define users, groups, resources and permissions within their software. It also facilitates secure server-to-server interactions.
+Goiabada provides a solution for **user management**, allowing application developers to define users, groups, resources and permissions within their software. It also allows the authentication and authorization of server-to-server interactions.
 
 - Written in Go for speed and minimal resource consumption (container image size < 35 MB)
 - User-friendly interface

diff --git a/mkdocs/docs/license.md b/mkdocs/docs/license.md
@@ -9,7 +9,7 @@ Goiabada is open source and 100% free of charge. It has a permissive license, wh
 ```
 MIT License
 
-Copyright (c) 2023 Leonardo D'Ippolito (leo@goiabada.dev)
+Copyright (c) 2023 Leonardo D'Ippolito (contact@leodip.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,4 +8,4 @@ For running integration tests, use the `run-tests` script. Test coverage will be

		Goiabada uses [GORM](https://gorm.io/) for data access, [Tailwind CSS](https://tailwindcss.com/) with [DaisyUI](https://daisyui.com/) for UI & styling, and the [chi router](https://github.com/go-chi/chi) to manage the incoming HTTP requests.

		If you're interested in contributing to the project, don't hesitate to reach out to me at [leo@goiabada.dev](mailto:leo@goiabada.dev), or submit pull requests. Your involvement is welcome and appreciated.
		If you're interested in contributing to the project, don't hesitate to reach out to me at [contact@leodip.com](mailto:contact@leodip.com), or submit pull requests. Your involvement is welcome and appreciated.