feat: add repository cloning instructions in README

Includes instructions for cloning repositories using the git client over HTTP(S) in the README. Updated project version to 0.0.6 to reflect these changes. Minor formatting improvements in index.html to enhance readability.

README.md

@@ -9,6 +9,7 @@ Instead of using the GitHub API or screen scraping, GitCloak interfaces directly
 - Browse directories and files in GitHub repositories.
 - View the content of files directly in the browser.
 - Responsive design with Bootstrap for a clean and professional look.
+- Cloning repositories using the git client over HTTP(S).
 
 ## Getting Started
 
@@ -110,6 +111,12 @@ GitCloak currently supports the following environment variables:
   http://localhost:8107/<owner>/<repo>/raw/main/<file_path>
   ```
 
+- **Clone Repository**: To clone a repository using your git client, just do as you would normally do:
+
+  ```sh
+  git clone http://localhost:8107/<owner>/<repo>
+  ```
+
 ## Contributing
 
 We welcome contributions to improve GitCloak! To contribute:

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "gitcloak"
-version = "0.0.5"
+version = "0.0.6"
 authors = [{ name = "Private.coffee Team", email = "support@private.coffee" }]
 description = "Simple Python-based private frontend for GitHub repositories"
 readme = "README.md"

src/gitcloak/templates/index.html

@@ -1,20 +1,41 @@
-{% extends 'base.html' %}
+{% extends 'base.html' %} {% block title %}Welcome to GitCloak{% endblock %} {%
-
+block content %}
-{% block title %}Welcome to GitCloak{% endblock %}
-
-{% block content %}
 <div class="jumbotron">
   <h1 class="display-8">Welcome to GitCloak!</h1>
-    <p class="lead">GitCloak is a simple web frontend that lets you browse public GitHub repositories and view their contents.</p>
+  <p class="lead">
-    <p class="lead">Unlike other GitHub interfaces, GitCloak does not use APIs or screen scraping, needs no credentials and does not use any JavaScript.</p>
+    GitCloak is a simple web frontend that lets you browse public GitHub
-    <hr class="my-4">
+    repositories and view their contents.
-    <p>To get started, simply replace <code>github.com</code> in the URL - the following paths are already available:</p>
+  </p>
+  <p class="lead">
+    Unlike other GitHub interfaces, GitCloak does not use APIs or screen
+    scraping, allows cloning repositories, needs no credentials and does not use
+    any JavaScript.
+  </p>
+  <hr class="my-4" />
+  <p>
+    To get started, simply replace <code>github.com</code> in the URL - the
+    following paths are already available:
+  </p>
   <ul>
-        <li><code>/&lt;owner&gt;/&lt;repo&gt;/</code> - View the root directory of the repository</li>
+    <li>
-        <li><code>/&lt;owner&gt;/&lt;repo&gt;/tree/main/&lt;path&gt;</code> - View a specific directory</li>
+      <code>/&lt;owner&gt;/&lt;repo&gt;/</code> - View the root directory of the
-        <li><code>/&lt;owner&gt;/&lt;repo&gt;/raw/main/&lt;file_path&gt;</code> - View the raw content of a specific file</li>
+      repository
+    </li>
+    <li>
+      <code>/&lt;owner&gt;/&lt;repo&gt;/tree/main/&lt;path&gt;</code> - View a
+      specific directory
+    </li>
+    <li>
+      <code>/&lt;owner&gt;/&lt;repo&gt;/raw/main/&lt;file_path&gt;</code> - View
+      the raw content of a specific file
+    </li>
   </ul>
-    <p>For example, to see the contents of the <code>PrivateCoffee/transfer.coffee</code> repository, simply visit <a href="/PrivateCoffee/transfer.coffee/">/PrivateCoffee/transfer.coffee/</a>.</p>
+  <p>
+    For example, to see the contents of the
+    <code>PrivateCoffee/transfer.coffee</code> repository, simply visit
+    <a href="/PrivateCoffee/transfer.coffee/">/PrivateCoffee/transfer.coffee/</a
+    >.
+  </p>
   <p>Other features are still in development, so stay tuned!</p>
 </div>
 {% endblock %}