Update README.md and docs

README.md

@@ -1,3 +1,22 @@
+![Python](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)
+
+###### Platform Supported
+![Generic badge](https://img.shields.io/badge/Platform-MacOS|Windows-1f425f.svg)
+
+###### Repo Stats
+[![GitHub](https://img.shields.io/github/license/thevickypedia/expose)][LICENSE]
+[![GitHub repo size](https://img.shields.io/github/repo-size/thevickypedia/expose)][API_REPO]
+[![GitHub code size](https://img.shields.io/github/languages/code-size/thevickypedia/expose)][API_REPO]
+
+###### Deployments
+[![doc](https://github.com/thevickypedia/expose/actions/workflows/pages/pages-build-deployment/badge.svg)][gha_pages]
+[![pypi](https://github.com/thevickypedia/expose/actions/workflows/python-publish.yml/badge.svg)][gha_pypi]
+[![markdown](https://github.com/thevickypedia/expose/actions/workflows/markdown-validation.yml/badge.svg)][gha_markdown]
+
+[![Pypi-format](https://img.shields.io/pypi/format/expose-localhost)](https://pypi.org/project/expose-localhost/#files)
+[![Pypi-status](https://img.shields.io/pypi/status/expose-localhost)](https://pypi.org/project/expose-localhost)
+[![sourcerank](https://img.shields.io/librariesio/sourcerank/pypi/expose-localhost)](https://libraries.io/pypi/expose-localhost)
+
 # Expose localhost using EC2
 Reverse proxy that creates a secure tunnel from public endpoint to locally running web service
 
@@ -133,7 +152,7 @@ Styling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) <br>
 Clean code with pre-commit hooks: [`flake8`](https://flake8.pycqa.org/en/latest/) and 
 [`isort`](https://pycqa.github.io/isort/)
 
-## [Release Notes](https://github.com/thevickypedia/expose/blob/main/release_notes.rst)
+## [Release Notes][release-notes]
 **Requirement**
 ```shell
 python -m pip install gitverse
@@ -158,17 +177,28 @@ pre-commit run --all-files
 ```
 
 ### Pypi Package
-[![pypi-module](https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg)](https://packaging.python.org/tutorials/packaging-projects/)
+[![pypi-module](https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg)][pypi-read]
 
-[https://pypi.org/project/expose-localhost/](https://pypi.org/project/expose-localhost/)
+[https://pypi.org/project/expose-localhost/][pypi]
 
 ### Runbook
-[![made-with-sphinx-doc](https://img.shields.io/badge/Code%20Docs-Sphinx-1f425f.svg)](https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html)
+[![made-with-sphinx-doc](https://img.shields.io/badge/Code%20Docs-Sphinx-1f425f.svg)][sphinx-read]
 
-[https://thevickypedia.github.io/expose/](https://thevickypedia.github.io/expose/)
+[https://thevickypedia.github.io/expose/][docs]
 
 ## License & copyright
 
 &copy; Vignesh Rao
 
-Licensed under the [MIT License](https://github.com/thevickypedia/expose/blob/main/LICENSE)
+Licensed under the [MIT License][LICENSE]
+
+[LICENSE]: https://github.com/thevickypedia/expose/blob/main/LICENSE
+[API_REPO]: https://api.github.com/repos/thevickypedia/expose
+[pypi]: https://pypi.org/project/expose-localhost/
+[pypi-read]: https://packaging.python.org/tutorials/packaging-projects/
+[sphinx-read]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html
+[docs]: https://thevickypedia.github.io/expose/
+[release-notes]: https://github.com/thevickypedia/expose/blob/main/release_notes.rst
+[gha_pages]: https://github.com/thevickypedia/expose/actions/workflows/pages/pages-build-deployment
+[gha_pypi]: https://github.com/thevickypedia/expose/actions/workflows/python-publish.yml
+[gha_markdown]: https://github.com/thevickypedia/expose/actions/workflows/markdown-validation.yml

docs/README.html

@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Expose localhost using EC2 &#8212; Expose  documentation</title>
+    <title>Platform Supported &#8212; Expose  documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css" />
 
@@ -33,7 +33,7 @@ <h3>Navigation</h3>
           <a href="index.html" title="Expose - Expose a web service on localhost to public internet using AWS EC2"
              accesskey="P">previous</a> |</li>
         <li class="nav-item nav-item-0"><a href="index.html">Expose  documentation</a> &#187;</li>
-        <li class="nav-item nav-item-this"><a href="">Expose localhost using EC2</a></li> 
+        <li class="nav-item nav-item-this"><a href="">Platform Supported</a></li> 
       </ul>
     </div>  
 
@@ -42,7 +42,27 @@ <h3>Navigation</h3>
         <div class="bodywrapper">
           <div class="body" role="main">
 
-  <section id="expose-localhost-using-ec2">
+  <p><img alt="Python" src="https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue" /></p>
+<section id="platform-supported">
+<h1>Platform Supported<a class="headerlink" href="#platform-supported" title="Permalink to this heading">¶</a></h1>
+<p><img alt="Generic badge" src="https://img.shields.io/badge/Platform-MacOS%7CWindows-1f425f.svg" /></p>
+</section>
+<section id="repo-stats">
+<h1>Repo Stats<a class="headerlink" href="#repo-stats" title="Permalink to this heading">¶</a></h1>
+<p><a class="reference external" href="https://github.com/thevickypedia/expose/blob/main/LICENSE"><img alt="GitHub" src="https://img.shields.io/github/license/thevickypedia/expose" /></a>
+<a class="reference external" href="https://api.github.com/repos/thevickypedia/expose"><img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/thevickypedia/expose" /></a>
+<a class="reference external" href="https://api.github.com/repos/thevickypedia/expose"><img alt="GitHub code size" src="https://img.shields.io/github/languages/code-size/thevickypedia/expose" /></a></p>
+</section>
+<section id="deployments">
+<h1>Deployments<a class="headerlink" href="#deployments" title="Permalink to this heading">¶</a></h1>
+<p><a class="reference external" href="https://github.com/thevickypedia/expose/actions/workflows/pages/pages-build-deployment"><img alt="doc" src="https://github.com/thevickypedia/expose/actions/workflows/pages/pages-build-deployment/badge.svg" /></a>
+<a class="reference external" href="https://github.com/thevickypedia/expose/actions/workflows/python-publish.yml"><img alt="pypi" src="https://github.com/thevickypedia/expose/actions/workflows/python-publish.yml/badge.svg" /></a>
+<a class="reference external" href="https://github.com/thevickypedia/expose/actions/workflows/markdown-validation.yml"><img alt="markdown" src="https://github.com/thevickypedia/expose/actions/workflows/markdown-validation.yml/badge.svg" /></a></p>
+<p><a class="reference external" href="https://pypi.org/project/expose-localhost/#files"><img alt="Pypi-format" src="https://img.shields.io/pypi/format/expose-localhost" /></a>
+<a class="reference external" href="https://pypi.org/project/expose-localhost"><img alt="Pypi-status" src="https://img.shields.io/pypi/status/expose-localhost" /></a>
+<a class="reference external" href="https://libraries.io/pypi/expose-localhost"><img alt="sourcerank" src="https://img.shields.io/librariesio/sourcerank/pypi/expose-localhost" /></a></p>
+</section>
+<section id="expose-localhost-using-ec2">
 <h1>Expose localhost using EC2<a class="headerlink" href="#expose-localhost-using-ec2" title="Permalink to this heading">¶</a></h1>
 <p>Reverse proxy that creates a secure tunnel from public endpoint to locally running web service</p>
 <section id="setup">
@@ -208,7 +228,10 @@ <h2>License &amp; copyright<a class="headerlink" href="#license-copyright" title
   <div>
     <h3><a href="index.html">Table of Contents</a></h3>
     <ul>
-<li><a class="reference internal" href="#">Expose localhost using EC2</a><ul>
+<li><a class="reference internal" href="#">Platform Supported</a></li>
+<li><a class="reference internal" href="#repo-stats">Repo Stats</a></li>
+<li><a class="reference internal" href="#deployments">Deployments</a></li>
+<li><a class="reference internal" href="#expose-localhost-using-ec2">Expose localhost using EC2</a><ul>
 <li><a class="reference internal" href="#setup">Setup</a><ul>
 <li><a class="reference internal" href="#environment-variables">Environment Variables:</a></li>
 </ul>
@@ -270,7 +293,7 @@ <h3>Navigation</h3>
           <a href="index.html" title="Expose - Expose a web service on localhost to public internet using AWS EC2"
              >previous</a> |</li>
         <li class="nav-item nav-item-0"><a href="index.html">Expose  documentation</a> &#187;</li>
-        <li class="nav-item nav-item-this"><a href="">Expose localhost using EC2</a></li> 
+        <li class="nav-item nav-item-this"><a href="">Platform Supported</a></li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">

docs/_sources/README.md.txt

@@ -1,3 +1,22 @@
+![Python](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)
+
+###### Platform Supported
+![Generic badge](https://img.shields.io/badge/Platform-MacOS|Windows-1f425f.svg)
+
+###### Repo Stats
+[![GitHub](https://img.shields.io/github/license/thevickypedia/expose)][LICENSE]
+[![GitHub repo size](https://img.shields.io/github/repo-size/thevickypedia/expose)][API_REPO]
+[![GitHub code size](https://img.shields.io/github/languages/code-size/thevickypedia/expose)][API_REPO]
+
+###### Deployments
+[![doc](https://github.com/thevickypedia/expose/actions/workflows/pages/pages-build-deployment/badge.svg)][gha_pages]
+[![pypi](https://github.com/thevickypedia/expose/actions/workflows/python-publish.yml/badge.svg)][gha_pypi]
+[![markdown](https://github.com/thevickypedia/expose/actions/workflows/markdown-validation.yml/badge.svg)][gha_markdown]
+
+[![Pypi-format](https://img.shields.io/pypi/format/expose-localhost)](https://pypi.org/project/expose-localhost/#files)
+[![Pypi-status](https://img.shields.io/pypi/status/expose-localhost)](https://pypi.org/project/expose-localhost)
+[![sourcerank](https://img.shields.io/librariesio/sourcerank/pypi/expose-localhost)](https://libraries.io/pypi/expose-localhost)
+
 # Expose localhost using EC2
 Reverse proxy that creates a secure tunnel from public endpoint to locally running web service
 
@@ -133,7 +152,7 @@ Styling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) <br>
 Clean code with pre-commit hooks: [`flake8`](https://flake8.pycqa.org/en/latest/) and 
 [`isort`](https://pycqa.github.io/isort/)
 
-## [Release Notes](https://github.com/thevickypedia/expose/blob/main/release_notes.rst)
+## [Release Notes][release-notes]
 **Requirement**
 ```shell
 python -m pip install gitverse
@@ -158,17 +177,28 @@ pre-commit run --all-files
 ```
 
 ### Pypi Package
-[![pypi-module](https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg)](https://packaging.python.org/tutorials/packaging-projects/)
+[![pypi-module](https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg)][pypi-read]
 
-[https://pypi.org/project/expose-localhost/](https://pypi.org/project/expose-localhost/)
+[https://pypi.org/project/expose-localhost/][pypi]
 
 ### Runbook
-[![made-with-sphinx-doc](https://img.shields.io/badge/Code%20Docs-Sphinx-1f425f.svg)](https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html)
+[![made-with-sphinx-doc](https://img.shields.io/badge/Code%20Docs-Sphinx-1f425f.svg)][sphinx-read]
 
-[https://thevickypedia.github.io/expose/](https://thevickypedia.github.io/expose/)
+[https://thevickypedia.github.io/expose/][docs]
 
 ## License & copyright
 
 &copy; Vignesh Rao
 
-Licensed under the [MIT License](https://github.com/thevickypedia/expose/blob/main/LICENSE)
+Licensed under the [MIT License][LICENSE]
+
+[LICENSE]: https://github.com/thevickypedia/expose/blob/main/LICENSE
+[API_REPO]: https://api.github.com/repos/thevickypedia/expose
+[pypi]: https://pypi.org/project/expose-localhost/
+[pypi-read]: https://packaging.python.org/tutorials/packaging-projects/
+[sphinx-read]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html
+[docs]: https://thevickypedia.github.io/expose/
+[release-notes]: https://github.com/thevickypedia/expose/blob/main/release_notes.rst
+[gha_pages]: https://github.com/thevickypedia/expose/actions/workflows/pages/pages-build-deployment
+[gha_pypi]: https://github.com/thevickypedia/expose/actions/workflows/python-publish.yml
+[gha_markdown]: https://github.com/thevickypedia/expose/actions/workflows/markdown-validation.yml

docs/index.html

@@ -18,7 +18,7 @@
 
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Expose localhost using EC2" href="README.html" /> 
+    <link rel="next" title="Platform Supported" href="README.html" /> 
   </head><body>
     <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
@@ -30,7 +30,7 @@ <h3>Navigation</h3>
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="README.html" title="Expose localhost using EC2"
+          <a href="README.html" title="Platform Supported"
              accesskey="N">next</a> |</li>
         <li class="nav-item nav-item-0"><a href="#">Expose  documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Expose - Expose a web service on localhost to public internet using AWS EC2</a></li> 
@@ -47,7 +47,10 @@ <h1>Expose - Expose a web service on localhost to public internet using AWS EC2<
 <div class="toctree-wrapper compound">
 <p class="caption" role="heading"><span class="caption-text">Read Me:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="README.html">Expose localhost using EC2</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="README.html">Platform Supported</a></li>
+<li class="toctree-l1"><a class="reference internal" href="README.html#repo-stats">Repo Stats</a></li>
+<li class="toctree-l1"><a class="reference internal" href="README.html#deployments">Deployments</a></li>
+<li class="toctree-l1"><a class="reference internal" href="README.html#expose-localhost-using-ec2">Expose localhost using EC2</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="README.html#setup">Setup</a></li>
 <li class="toctree-l2"><a class="reference internal" href="README.html#usage">Usage</a></li>
 <li class="toctree-l2"><a class="reference internal" href="README.html#coding-standards">Coding Standards</a></li>
@@ -1023,7 +1026,7 @@ <h3><a href="#">Table of Contents</a></h3>
   <div>
     <h4>Next topic</h4>
     <p class="topless"><a href="README.html"
-                          title="next chapter">Expose localhost using EC2</a></p>
+                          title="next chapter">Platform Supported</a></p>
   </div>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
@@ -1056,7 +1059,7 @@ <h3>Navigation</h3>
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="README.html" title="Expose localhost using EC2"
+          <a href="README.html" title="Platform Supported"
              >next</a> |</li>
         <li class="nav-item nav-item-0"><a href="#">Expose  documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Expose - Expose a web service on localhost to public internet using AWS EC2</a></li>