From 0b6a1b5d7a754d4da179605df5bb0d9fcd79dad4 Mon Sep 17 00:00:00 2001
From: truePhilipp <philipp@mayr.software>
Date: Thu, 2 May 2024 21:25:41 +0000
Subject: [PATCH] added README text and project links

---
 .gitignore     |  1 +
 README.md      | 33 +++++++++++++++++++++++++++++++++
 pyproject.toml |  4 ++--
 3 files changed, 36 insertions(+), 2 deletions(-)

diff --git a/.gitignore b/.gitignore
index ab816e4..34bd96f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,6 +3,7 @@
 
 ### Custom ###
 tests/test_project_test_result
+.vscode
 
 ### macOS ###
 # General
diff --git a/README.md b/README.md
index e69de29..cfca094 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,33 @@
+HTML To Django
+===
+
+Convert HTML files with special syntax to Django template files.
+
+Installation
+---
+TODO: pip install instructions
+
+Usage
+---
+```bash
+html_to_django <path to file or folder to convert>
+```
+
+Development
+===
+
+Testing
+---
+```bash
+python -m unittest discover tests --verbose
+```
+
+Stylechecks
+---
+```bash
+mypy --strict html_to_django
+```
+and
+```bash
+pycodestyle --max-line-length 120 html_to_django
+```
\ No newline at end of file
diff --git a/pyproject.toml b/pyproject.toml
index 4a9aaca..cb69ca1 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -33,8 +33,8 @@ dev = [
 ]
 
 [project.urls]
-Homepage = ""
-Issues = ""
+Homepage = "https://github.com/truePhilipp/html_to_django"
+Issues = "https://github.com/truePhilipp/html_to_django/issues"
 
 [project.scripts]
 html_to_django = "html_to_django.converter:command_entry"