From 1c6b70d640969e1da29ff3dd147dcf11ab8dc585 Mon Sep 17 00:00:00 2001 From: Kevin Veen-Birkenbach Date: Thu, 16 Jan 2025 22:56:02 +0100 Subject: [PATCH] Updated README.md --- .gitignore | 5 +++-- README.md | 9 +++++++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index ebcefbf..ab625c0 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ -app/static/cache/* -*__pycache__* \ No newline at end of file +app/config.yaml +*__pycache__* +app/static/cache/* \ No newline at end of file diff --git a/README.md b/README.md index 4c2f7bc..601f06d 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,14 @@ -# Landingpage +# Portfolio + +This software allows people and institutions to setup an easy landingpage\homepage to show their portfolio. It's configured via an yaml file. ## Access ### Locale [http://127.0.0.1:5000](http://127.0.0.1:5000) +## Configure +To configure this app create an config.yaml you can use config.sample.yaml as an example + ## Administrate Docker ### Stop and Destroy @@ -34,4 +39,4 @@ docker run -d -p 5000:5000 --name landingpage application-landingpage docker logs -f landingpage ``` ## Author -This software was created from [Kevin Veen-Birkenbach](https://www.veen.world/) with the help of [ChatGPT]() +This software was created from [Kevin Veen-Birkenbach](https://www.veen.world/).