From 7da845c73f44cbb8e26bd0cfe507ac3e990beceb Mon Sep 17 00:00:00 2001 From: klein panic Date: Wed, 23 Oct 2024 12:34:02 -0400 Subject: [PATCH] Updated README --- README.md | 10 ++++++++-- public/logo.txt | 2 +- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 978cdfd..c0d8759 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,8 @@ To run this project locally, you'll need: npm install ``` 4. **create an .env file** -> this is for the contact section, and some email features. This should be your email as this is designed to inform yourself about contact attemps. +> this is for the contact section, and enables email notification features. This should be your email as this is designed to inform yourself about contact attemps. +> Be warned: if using a gmail, you will need to setup an app password and use that instead of your own private email password. ``` EMAIL_ADDDRESS= EMAIL_PASSWORD= @@ -57,7 +58,7 @@ To run this project locally, you'll need: ## Folder Structure ```plaintext -kleinpanic-website/ +kleinpanicWeb/ │ ├── public/ # Static files (CSS, images, etc.) ├── views/ # Frontend templates (ejs) @@ -65,7 +66,12 @@ kleinpanic-website/ ├── blog/ # Dir to contain blogs ├── package.json # NPM installs. ├── server.js # Entry point for the server +├── .env # Text file for containing secrets +├── stderr.log # Log file created for error logs +├── package.json # File for JS dependencies +├── LICENSE # MIT License └── README.md # Project documentation + ``` --- diff --git a/public/logo.txt b/public/logo.txt index f8555bf..99dafd5 100644 --- a/public/logo.txt +++ b/public/logo.txt @@ -3,4 +3,4 @@ | ' /| | ___  _ _ __ | |__) |_ _ _ __  _ ___ |  < | |/ _ \| | '_ \| ___/ _` | '_ \| |/ __| | . \| | __/| | | | | | | (_| | | | | | (__  -|_|\_\_|\___||_|_| |_|_| \__,_|_| |_|_|\___| \ No newline at end of file +|_|\_\_|\___||_|_| |_|_| \__,_|_| |_|_|\___|