♻️ Refactor README.md for Flask YAML Editor

📚 Improved readability and coding standards adherence.
This commit is contained in:
Isaak Buslovich 2023-12-22 23:39:07 +01:00
parent dc1b2ecb08
commit 72d044b6e8
Signed by: Isaak
GPG Key ID: EEC31D6437FBCC63

View File

@ -1,6 +1,7 @@
# Flask YAML Editor # 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 ## Features
@ -10,7 +11,8 @@ Flask YAML Editor is a web application that provides an interface for reading an
## Getting Started ## 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 ### Prerequisites
@ -60,11 +62,14 @@ pip install Flask PyYAML
## License ## 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. 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 ## Acknowledgments