used MD file rather than rst file

README.md

@@ -0,0 +1,112 @@
+# About Zen-Knit:
+Zen-Knit is a formal (PDF), informal (HTML) report generator for data analyst and data scientist who wants to use python. RMarkdown alternative.
+Zen-Knit is good for creating reports, tutorials with embedded python. RMarkdown alternative. Python Markdown Support.
+
+
+[![Download Count](https://static.pepy.tech/personalized-badge/zen-knit?period=total&units=international_system&left_color=grey&right_color=green&left_text=Downloads)](https://pepy.tech/project/zen-knit)
+[![python](https://img.shields.io/pypi/pyversions/zen-knit.svg?color=green)](https://img.shields.io/pypi/pyversions/zen-knit.svg?color=green)
+[![license](https://img.shields.io/github/license/Zen-Reportz/zen_knit?color=green)](https://img.shields.io/github/license/Zen-Reportz/zen_knit?color=green)
+[![version](https://img.shields.io/pypi/v/zen-knit?color=green&label=pypi%20package)](https://img.shields.io/pypi/v/zen-knit?color=green&label=pypi%20package)
+
+
+# VS Code Plugin:
+Download VS Plugin from [MarketPlace](https://marketplace.visualstudio.com/items?itemName=ZenReportz.vscode-zen-knit)
+
+
+# Features:
+* Python 3.7+ compatibility
+* Support for IPython magics and rich output.
+* **Execute python code** in the chunks and **capture** input and output to a report.
+* **Use hidden code chunks,** i.e. code is executed, but not printed in the output file.
+* Capture matplotlib graphics.
+* Evaluate inline code in documentation chunks marked using ```{ }``` 
+* Publish reports from Python scripts. Similar to R markdown.
+* Interactive Plots using plotly
+* integrate it in your process. It will fit your need rather than you need to adjust for tool.
+* custom CSS support (HTTP(s) and local file)
+* direct sql support 
+* chaching executed code for faster report devlopement 
+* printing index of chunk or chunk name in console
+
+# Examples:
+All example are available [HERE](https://github.com/Zen-Reportz/zen_knit/tree/main/doc/example)
+
+
+## PDF example
+![PDF Code](./doc/example/screenshots/pdf_code.png)
+![PDF Output](./doc/example/screenshots/pdf_output.png)
+
+## PDF example with SQL
+![PDF SQL Code](./doc/example/screenshots/pdf_sql_code.png) 
+![PDF SQL Output](./doc/example/screenshots/pdf_sql_output.png) 
+
+## HTML example
+![HTML Code](./doc/example/screenshots/html_code.png) 
+![HTML Ouput ](./doc/example/screenshots/html_output.png)
+![HTML output 2](./doc/example/screenshots/html_output_2.png)
+
+## HTML example with custom CSS
+![HTML CDN CSS](./doc/example/screenshots/html_cdn_css_code.png) 
+![HTML Custom CSS](./doc/example/screenshots/html_custom_css_code.png)
+
+## HTML example with SQL
+![HTML SQL](./doc/example/screenshots/html_sql_code.png) 
+![HTML SQL output](./doc/example/screenshots/html_sql_output.png) 
+
+
+# Install
+
+From PyPi:
+
+  <code> pip install --upgrade zen-knit </code>
+
+or download the source and run::
+
+  <code> python setup.py install </code>
+
+
+## Other Dependency
+
+<code> install pandoc from : https://github.com/jgm/pandoc/releases </code>
+
+<code> install texlive for debian: sudo apt install texlive-full </code>
+
+<code> install texlive for window: https://www.tug.org/texlive/acquire-netinstall.html </code>
+
+<code> install texlive for mac: https://tug.org/texlive/quickinstall.html </code>
+
+
+## License information
+
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+## How to Use it
+
+  <code> pip install zen-knit
+
+  knit -f doc/example/html_example.pyz  -ofd doc/example/output/
+
+  knit -f doc/example/pdf_example.pyz  -ofd doc/example/output/
+
+  python doc/example/demo.py 
+
+  </code>

pyproject.toml

@@ -4,7 +4,7 @@ version = "0.2.0"
 description = "Zen-Knit is a formal (PDF), informal (HTML) report generator for data analyst and data scientist who wants to use python. Rmarkdown Alternative for Python"
 authors = ["Zen <[email protected]>"]
 license = "MIT"
-readme = "README.rst"
+readme = "README.md"
 homepage = "https://github.com/Zen-Reportz/zen_knit"
 repository = "https://github.com/Zen-Reportz/zen_knit"
 include = [