From c36f48e6e4d484fb130d3918d416ddc95abd4477 Mon Sep 17 00:00:00 2001 From: ryansurf Date: Mon, 27 May 2024 03:17:42 -0700 Subject: [PATCH] readme --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 811703c..d873f91 100644 --- a/README.md +++ b/README.md @@ -111,6 +111,8 @@ Change `.env.example` to `.env` **config.json** +| Variable | Description| +| -------- | ------- | | `port` | The port you want to open to run the application. Default = `8000` | | `ip_address` | The ip your server is running on. Default = `localhost` | @@ -131,7 +133,7 @@ Execute by running `python3 send_email.py`. Running with cron is a good use case Although this application was made with the cli in mind, there is a frontend. -`http://localhost:8000/home` **or** `:` if the application is running on a different host or you have changed the default port. +`http://localhost:8000/home` **or** `:/home` if the application is running on a different host or you have changed the default port. You may need to change `ip_address` in `config.json` to match the ip of the host running the machine.