Add Screenshots of available themes

- Added readme on setup.py
fasilwdr · Aug 8, 2024 · 3aa4eb0 · 3aa4eb0
1 parent ae1fc58
commit 3aa4eb0
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -50,6 +50,20 @@ Example:
 md2indexhtml path/to/yourfile.md path/to/output/dir --template path/to/template.html --css path/to/custom.css --title "My Documentation"
 ```
 
+## Themes
+
+### Default Theme
+
+![Default](screenshots/index.jpg)
+
+### GoDocs Theme
+
+![GoDocs](screenshots/godocs.jpg)
+
+### DocBox Theme
+
+![GoDocs](screenshots/docbox.jpg)
+
 # Python API
 
 You can also use the package programmatically in your Python code:

diff --git a/md2indexhtml/__init__.py b/md2indexhtml/__init__.py
@@ -4,7 +4,7 @@
 from .converter import convert_md_to_html
 
 # Version of the package
-__version__ = "0.1.0"
+__version__ = "0.1.1"
 
 # Define what is available when the package is imported
 __all__ = ["convert_md_to_html"]
diff --git a/screenshots/docbox.jpg b/screenshots/docbox.jpg
diff --git a/screenshots/godocs.jpg b/screenshots/godocs.jpg
diff --git a/screenshots/index.jpg b/screenshots/index.jpg
diff --git a/setup.py b/setup.py
@@ -3,15 +3,16 @@
 
 setup(
     name='md2indexhtml',
-    version='0.1.0',
-    description='Convert Markdown files to index.html for Odoo modules',
+    version='0.1.1',
+    description='Convert Markdown files to index.html',
     author='Your Name',
     author_email='[email protected]',
     url='https://github.com/fasilwdr/md2indexhtml',
     packages=find_packages(),
     install_requires=[
         'markdown',
     ],
+    readme="README.md",
     classifiers=[
         'Programming Language :: Python :: 3',
         'License :: OSI Approved :: MIT License',