From cd97e85b54f3f6ffcd89a5f1bd82df678da74933 Mon Sep 17 00:00:00 2001 From: Celneo <128137635+celneo@users.noreply.github.com> Date: Fri, 23 Jan 2026 22:43:45 +0200 Subject: [PATCH] Update README.md This PR improves the overall clarity, correctness, and consistency of the README documentation. The changes focus on fixing a small number of genuine grammar and spelling issues, as well as making minor wording adjustments to better align with common technical documentation standards. --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 33d5562d..a2ec2d18 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # ACCESS -Meet Access, a centralized portal for employees to transparently discover, request, and manage their access for all internal systems needed to do their jobs. If you're interested in the project, come chat with us! +Meet Access, a centralized portal that allows employees to transparently discover, request, and manage access for all internal systems needed to do their jobs. If you're interested in the project, feel free to chat with us!

Join our Discord!

@@ -12,7 +12,7 @@ The access service exists to help answer the following questions for each person - All Users - What do I have access to? - - What does a teammate have access to that I don’t? + - What access does a teammate have that I don’t have? - What groups and roles are available? - Can I get access? - Team Leads @@ -98,7 +98,7 @@ npx openapi-codegen gen api ## Tests -We use tox to run our tests, which should be installed into the python venv from +We use tox to run our tests. It should be installed into the Python venv from our `requirements.txt`. Invoke the tests using `tox -e test`. @@ -246,7 +246,7 @@ The `.env.production` file is where you configure the application. If you are using Cloudflare Access, ensure that you configure `CLOUDFLARE_TEAM_DOMAIN` and `CLOUDFLARE_APPLICATION_AUDIENCE`. `SECRET_KEY` and `OIDC_CLIENT_SECRETS` do not need to be set and can be removed from your env file. -Else, if you are using a generic OIDC identity provider (such as Okta), then you should configure `SECRET_KEY` and `OIDC_CLIENT_SECRETS`. `CLOUDFLARE_TEAM_DOMAIN` and `CLOUDFLARE_APPLICATION_AUDIENCE` do not need to be set and can be removed from your env file. Make sure to also mount your `client-secrets.json` file to the container if you don't have it inline. +Otherwise, if you are using a generic OIDC identity provider (such as Okta), then you should configure `SECRET_KEY` and `OIDC_CLIENT_SECRETS`. `CLOUDFLARE_TEAM_DOMAIN` and `CLOUDFLARE_APPLICATION_AUDIENCE` do not need to be set and can be removed from your env file. Make sure to also mount your `client-secrets.json` file to the container if you don't have it inline. ### Access application configuration