From bfd8e4fa36116d1521fa1c34fb05b5b3471d8354 Mon Sep 17 00:00:00 2001 From: TVanteeffelen Date: Fri, 8 May 2026 16:21:43 -0400 Subject: [PATCH] Update README.md --- README.md | 39 +++++++++++++++++++++++++++++++-------- 1 file changed, 31 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9a0e5a5..2c5452d 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,34 @@ -# MerakiApiUtilities +# Meraki API Utilities -.ENV file required to run both scripts. +## Configuration -ENV Variables: +This project requires a `.env` file to run both scripts. -- **API_KEY** = Your Meraki API key to access your Meraki networks. -- **SMTP_SERVER** = Your outgoing SMTP mail server. -- **SMTP_PORT** = Your outgoing SMTP mail port. -- **SMTP_EMAIL** = Your outgoing SMTP email address. -- **SMTP_PASS** = Your outgoing SMTP email password. \ No newline at end of file +--- + +## Environment Variables + +The following environment variables must be defined in your `.env` file: + +- **API_KEY** + Your Cisco Meraki API key used to access and manage Meraki networks. + +- **SMTP_SERVER** + Your outgoing SMTP mail server address. + +- **SMTP_PORT** + Your outgoing SMTP mail server port. + +- **SMTP_EMAIL** + The email address used to send notifications. + +- **SMTP_PASS** + The password for the SMTP email account. + +--- + +## Notes + +- Ensure the `.env` file is stored securely and is not committed to version control. +- Verify that the API key has the required permissions for your intended operations. +- SMTP credentials should be for a dedicated service account where possible. \ No newline at end of file