From 027f023ff534d84207c69ba6d21d1ad6ccd935b7 Mon Sep 17 00:00:00 2001
From: Oli Passey <oli@hedgerows.net>
Date: Thu, 19 Dec 2024 17:49:11 +0000
Subject: [PATCH] Update README.md

---
 README.md | 36 +++++++++++++++++++++++++++++++++++-
 1 file changed, 35 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 23a7ec2..6706f44 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,35 @@
-# AzAppRegistrationExpiry
\ No newline at end of file
+# AzAppRegistrationExpiry
+
+A simple python app to warn of upcoming App Registration Secret / Password Expiry on Azure Entra ID.
+
+## Installation
+
+Requires Python 3.12  
+Install requirements from requirements.txt
+
+```bash
+pip install -r requirements.txt
+```
+
+## Usage
+
+Amend the credentials in .env to match your environment.  
+You will need to create an App Registration with API Permissions:  
+- Application.ReadWrite.All  
+- Files.ReadWrite.All
+- Sites.ReadWrite.All
+- User.Read
+- User.Read.All  
+
+Create an Excel Sheet within Business OneDrive and add the ID to the .env file  
+Add SMTP Sending details to .env (AWS Simple E-Mail Service was used in development)  
+
+
+```python
+python main.py
+```
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first
+to discuss what you would like to change.