fix readme in package, change example helps to dark for contrast #48

django-commons · Apr 3, 2024 · 027610d · 027610d
1 parent 2c94075
commit 027610d
Show file tree

Hide file tree

Showing 11 changed files with 378 additions and 381 deletions.
diff --git a/README.md b/README.md
@@ -173,6 +173,6 @@ More complex groups and subcommand hierarchies can be defined. For example, this
 ```
 
 ![Grouping and Hierarchies Example](https://raw.githubusercontent.com/bckohan/django-typer/main/django_typer/examples/helps/hierarchy.svg)
-![Grouping and Hierarchies Example](https://raw.githubusercontent.com/bckohan/django-typer/main/django_typer/examples/helps/hierarchy_math.svg)
-![Grouping and Hierarchies Example](https://raw.githubusercontent.com/bckohan/django-typer/main/django_typer/examples/helps/hierarchy_math_multiply.svg)
-![Grouping and Hierarchies Example](https://raw.githubusercontent.com/bckohan/django-typer/main/django_typer/examples/helps/hierarchy_math_divide.svg)
+![Grouping and Hierarchies Example - math](https://raw.githubusercontent.com/bckohan/django-typer/main/django_typer/examples/helps/hierarchy_math.svg)
+![Grouping and Hierarchies Example - math multiply](https://raw.githubusercontent.com/bckohan/django-typer/main/django_typer/examples/helps/hierarchy_math_multiply.svg)
+![Grouping and Hierarchies Example - math divide](https://raw.githubusercontent.com/bckohan/django-typer/main/django_typer/examples/helps/hierarchy_math_divide.svg)
diff --git a/django_typer/examples/helps/basic.svg b/django_typer/examples/helps/basic.svg
diff --git a/django_typer/examples/helps/hierarchy.svg b/django_typer/examples/helps/hierarchy.svg
diff --git a/django_typer/examples/helps/hierarchy_math.svg b/django_typer/examples/helps/hierarchy_math.svg
diff --git a/django_typer/examples/helps/hierarchy_math_divide.svg b/django_typer/examples/helps/hierarchy_math_divide.svg
diff --git a/django_typer/examples/helps/hierarchy_math_multiply.svg b/django_typer/examples/helps/hierarchy_math_multiply.svg
diff --git a/django_typer/examples/helps/multi.svg b/django_typer/examples/helps/multi.svg
diff --git a/django_typer/examples/helps/multi_create.svg b/django_typer/examples/helps/multi_create.svg
diff --git a/django_typer/examples/helps/multi_delete.svg b/django_typer/examples/helps/multi_delete.svg
diff --git a/doc/source/changelog.rst b/doc/source/changelog.rst
@@ -5,6 +5,7 @@ Change Log
 v1.1.0
 ======
 
+* Implemented `Convert readme to markdown. <https://github.com/bckohan/django-typer/issues/48>`_
 * Fixed `typer 0.12.0 breaks django_typer 1.0.9 <https://github.com/bckohan/django-typer/issues/47>`_
 
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ version = "1.1.0"
 description = "Use Typer to define the CLI for your Django management commands."
 authors = ["Brian Kohan <bckohan@gmail.com>"]
 license = "MIT"
-readme = "README.rst"
+readme = "README.md"
 repository = "https://github.com/bckohan/django-typer"
 homepage = "https://django-typer.readthedocs.io"
 keywords = ["django", "CLI", "management", "Typer", "commands"]