added README text and project links

.gitignore

@@ -3,6 +3,7 @@
 
 ### Custom ###
 tests/test_project_test_result
+.vscode
 
 ### macOS ###
 # General

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
+```

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"