From 72d044b6e8cda3d1c39a1572b2a3b2ceae0c068e Mon Sep 17 00:00:00 2001 From: Isaak Date: Fri, 22 Dec 2023 23:39:07 +0100 Subject: [PATCH] :recycle: Refactor README.md for Flask YAML Editor :books: Improved readability and coding standards adherence. --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cabafc6..c1b49e4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # Flask YAML Editor -Flask YAML Editor is a web application that provides an interface for reading and updating YAML file content. This application is built using Flask and serves an HTML page that interacts with the Flask backend to manage YAML data. +Flask YAML Editor is a web application that provides an interface for reading and updating YAML file content. This +application is built using Flask and serves an HTML page that interacts with the Flask backend to manage YAML data. ## Features @@ -10,7 +11,8 @@ Flask YAML Editor is a web application that provides an interface for reading an ## Getting Started -These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. +These instructions will get you a copy of the project up and running on your local machine for development and testing +purposes. ### Prerequisites @@ -60,11 +62,14 @@ pip install Flask PyYAML ## License -This project is licensed under a custom licence. This licence permits private and non-commercial use, testing, and use by the author's employer under certain conditions. It prohibits modification, distribution, and commercial use by others without a separate licence. +This project is licensed under a custom licence. This licence permits private and non-commercial use, testing, and use +by the author's employer under certain conditions. It prohibits modification, distribution, and commercial use by others +without a separate licence. See the [LICENSE.md](LICENSE.md) file for more details. -For questions regarding the use, modification, or redistribution of this software, please contact Isaak Buslovich at isaak.buslovich@potsdam.de. +For questions regarding the use, modification, or redistribution of this software, please contact Isaak Buslovich at +isaak.buslovich@potsdam.de. ## Acknowledgments