From 83da89cae6bfb836b31126d72f1238c3ddb22aa1 Mon Sep 17 00:00:00 2001 From: Mike Geppert Date: Sun, 20 Jul 2025 20:49:59 -0500 Subject: [PATCH] Update README.md with project description and development information --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 047477f..19f6183 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,18 @@ -# Sample GitLab Project +# SSL Management Project -This sample project shows how a project in GitLab looks for demonstration purposes. It contains issues, merge requests and Markdown files in many branches, -named and filled with lorem ipsum. +This project provides utilities for managing SSL certificates for UniFi devices such as UDM-SE. The tool helps automate the process of obtaining, validating, and deploying SSL certificates to UniFi devices. -You can look around to get an idea how to structure your project and, when done, you can safely delete this project. +## Development -[Learn more about creating GitLab projects.](https://docs.gitlab.com/ee/gitlab-basics/create-project.html) +Development for this project is done on the `develop` branch. The `master` branch is reserved for stable releases. + +## Features + +- Check certificate expiration dates +- Validate certificate chains +- Generate self-signed certificates for testing +- Deploy certificates to UniFi devices + +## Configuration + +The project uses a configuration file (`config.json`) to store default settings. See the guidelines document for more information.