Merge branch 'SubstantialCattle5:main' into main

Author: Janmesh23

.github/workflows/clone.yml

@@ -0,0 +1,118 @@
+name: GitHub Clone Count Update Everyday
+
+on:
+  schedule:
+    - cron: "0 0 * * *"  # Run daily at midnight UTC
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GH_PAT }}
+          fetch-depth: 0
+      
+      - name: gh login
+        run: echo "${{ secrets.GH_PAT }}" | gh auth login --with-token
+
+      - name: parse latest clone count
+        run: |
+          curl --user "${{ github.actor }}:${{ secrets.GH_PAT }}" \
+            -H "Accept: application/vnd.github.v3+json" \
+            https://api.github.com/repos/${{ github.repository }}/traffic/clones \
+            > clone.json
+
+      - name: create gist and download previous count
+        id: set_id
+        run: |
+          # Check if GIST_ID secret exists and is not empty
+          if [ -n "${{ secrets.GIST_ID }}" ]; then
+              echo "GIST_ID found: ${{ secrets.GIST_ID }}"
+              echo "GIST=${{ secrets.GIST_ID }}" >> $GITHUB_OUTPUT
+              curl -f https://gist.githubusercontent.com/${{ github.actor }}/${{ secrets.GIST_ID }}/raw/clone.json > clone_before.json 2>/dev/null || cp clone.json clone_before.json
+              if cat clone_before.json | grep '404: Not Found' 2>/dev/null; then
+                echo "GIST_ID not valid anymore. Creating another gist..."
+                gist_id=$(gh gist create clone.json | awk -F / '{print $NF}')
+                echo "New GIST_ID: $gist_id"
+                echo $gist_id | gh secret set GIST_ID
+                echo "GIST=$gist_id" >> $GITHUB_OUTPUT
+                cp clone.json clone_before.json
+                git rm --ignore-unmatch  CLONE.md
+              fi
+          else
+              echo "GIST_ID not found. Creating a gist..."
+              gist_id=$(gh gist create clone.json | awk -F / '{print $NF}')
+              echo "Created GIST_ID: $gist_id"
+              echo $gist_id | gh secret set GIST_ID
+              echo "GIST=$gist_id" >> $GITHUB_OUTPUT
+              cp clone.json clone_before.json
+          fi
+          
+          # Ensure clone_before.json has valid content for the Python script
+          if [ ! -s clone_before.json ] || ! jq empty clone_before.json 2>/dev/null; then
+            echo "clone_before.json is empty or invalid, using current clone.json"
+            cp clone.json clone_before.json
+          fi
+
+      - name: update clone.json
+        run: |
+          curl https://raw.githubusercontent.com/MShawon/github-clone-count-badge/master/main.py > main.py
+          python3 main.py
+
+      - name: Update gist with latest count
+        run: |
+          content=$(sed -e 's/\\/\\\\/g' -e 's/\t/\\t/g' -e 's/\"/\\"/g' -e 's/\r//g' "clone.json" | sed -E ':a;N;$!ba;s/\r{0,1}\n/\\n/g')
+          echo '{"description": "${{ github.repository }} clone statistics", "files": {"clone.json": {"content": "'"$content"'"}}}' > post_clone.json
+          curl -s -X PATCH \
+            --user "${{ github.actor }}:${{ secrets.GH_PAT }}" \
+            -H "Content-Type: application/json" \
+            -d @post_clone.json https://api.github.com/gists/${{ steps.set_id.outputs.GIST }} > /dev/null 2>&1
+
+      - name: Update README with clone badge
+        run: |
+          GIST_ID="${{ steps.set_id.outputs.GIST }}"
+          
+          echo "GIST_ID: $GIST_ID"
+          
+          # Only update if we have a valid GIST_ID
+          if [ -n "$GIST_ID" ]; then
+            shields="https://img.shields.io/badge/dynamic/json?color=success&label=Clone&query=count&url="
+            url="https://gist.githubusercontent.com/${{ github.actor }}/${GIST_ID}/raw/clone.json"
+            repo="https://github.com/${{ github.repository }}"
+            badge="[![GitHub Clones](${shields}${url}&logo=github)](${repo})"
+            
+            echo "Generated badge: $badge"
+            
+            # Check if badge already exists in README
+            if ! grep -q "GitHub Clones" README.md; then
+              echo "Badge not found in README, adding it..."
+              # Escape special characters for sed (especially & which means "matched pattern")
+              escaped_badge=$(echo "$badge" | sed 's/[&/\]/\\&/g')
+              # Replace the comment placeholder with the actual badge
+              sed -i 's|<!-- Clone badge will be auto-generated after first workflow run -->|'"$escaped_badge"'|g' README.md
+              
+              echo "README after replacement:"
+              head -n 10 README.md
+              
+              git config --global user.name "GitHub Action"
+              git config --global user.email "action@github.com"
+              git add README.md
+              
+              if git diff --staged --quiet; then
+                echo "No changes to commit"
+              else
+                echo "Committing changes..."
+                git commit -m "Add clone count badge to README"
+                git push origin main
+                echo "Changes pushed successfully"
+              fi
+            else
+              echo "Badge already exists in README, skipping update"
+            fi
+          else
+            echo "No GIST_ID found, skipping README update"
+          fi
+

README.md

@@ -4,16 +4,17 @@
 [![Release](https://github.com/substantialcattle5/sietch/actions/workflows/release.yml/badge.svg)](https://github.com/substantialcattle5/sietch/actions/workflows/release.yml)
 [![codecov](https://codecov.io/gh/substantialcattle5/sietch/branch/main/graph/badge.svg)](https://codecov.io/gh/substantialcattle5/sietch)
 [![Go Report Card](https://goreportcard.com/badge/github.com/substantialcattle5/sietch)](https://goreportcard.com/report/github.com/substantialcattle5/sietch)
+[![GitHub Clones](https://img.shields.io/badge/dynamic/json?color=success&label=Clone&query=count&url=https://gist.githubusercontent.com/SubstantialCattle5/a8c741d7828edd5af9f6128e583ff9a7/raw/clone.json&logo=github)](https://github.com/SubstantialCattle5/Sietch)
 
 Sietch creates self-contained encrypted vaults that can sync over LAN, sneakernet (USB drives), or weak WiFi networks. It operates fully offline, using chunked data, encryption, and peer-to-peer protocols to ensure your files are always protected and available—even when the internet is not.
 
 ## Why Sietch?
 
 Sietch Vault is designed for environments where:
 
-* Internet is scarce, censored, or unreliable
-* Data privacy is a necessity, not an optional feature
-* People work nomadically—researchers, journalists, activists
+- Internet is scarce, censored, or unreliable
+- Data privacy is a necessity, not an optional feature
+- People work nomadically—researchers, journalists, activists
 
 ## Quick Start
 
@@ -28,12 +29,14 @@ make build
 ### Basic Usage
 
 **Create a vault**
+
 ```bash
 sietch init --name dune --key-type aes        # AES-256-GCM encryption
 sietch init --name dune --key-type chacha20   # ChaCha20-Poly1305 encryption
 ```
 
 **Add files**
+
 ```bash
 # Single file
 sietch add ./secrets/thumper-plans.pdf documents/
@@ -46,13 +49,15 @@ sietch add ~/photos/img1.jpg ~/photos/img2.jpg vault/photos/
 ```
 
 **Sync over LAN**
+
 ```bash
 sietch sync /ip4/192.168.1.42/tcp/4001/p2p/QmPeerID
 # or auto-discover peers
 sietch sync
 ```
 
 **Retrieve files**
+
 ```bash
 sietch get thumper-plans.pdf ./retrieved/
 ```
@@ -70,30 +75,38 @@ sietch get thumper-plans.pdf ./retrieved/
 ## How It Works
 
 ### Chunking & Deduplication
-* Files are split into configurable chunks (default: 4MB)
-* Identical chunks across files are deduplicated to save space
-* Please Refer [this](internal/deduplication/README.md) documentation to understand how Deduplication works.
+
+- Files are split into configurable chunks (default: 4MB)
+- Identical chunks across files are deduplicated to save space
+- Please Refer [this](internal/deduplication/README.md) documentation to understand how Deduplication works.
 
 ### Encryption
+
 Each chunk is encrypted before storage using:
-* **Symmetric**: AES-256-GCM or ChaCha20-Poly1305 with passphrase
-* **Asymmetric**: GPG-compatible public/private keypairs
+
+- **Symmetric**: AES-256-GCM or ChaCha20-Poly1305 with passphrase
+- **Asymmetric**: GPG-compatible public/private keypairs
 
 ### Peer Discovery
+
 Peers discover each other via:
-* LAN gossip (UDP broadcast)
-* Manual IP whitelisting
-* QR-code sharing *(coming soon)*
+
+- LAN gossip (UDP broadcast)
+- Manual IP whitelisting
+- QR-code sharing _(coming soon)_
 
 ### Syncing
+
 Inspired by rsync, Sietch only transfers:
-* Missing chunks
-* Changed metadata
-* Over encrypted TCP connections with optional compression
+
+- Missing chunks
+- Changed metadata
+- Over encrypted TCP connections with optional compression
 
 ## Available Commands
 
 ### Core Operations
+
 ```bash
 sietch init [flags]                    # Initialize a new vault
 sietch add <source> <destination> [args...]  # Add files to vault (multiple file support)
@@ -103,13 +116,15 @@ sietch delete <filename>               # Delete files from vault
 ```
 
 ### Network Operations
+
 ```bash
 sietch discover [flags]                # Discover peers on local network
 sietch sync [peer-address]             # Sync with other vaults
 sietch sneak [flags]                   # Transfer via sneakernet (USB)
 ```
 
 ### Management
+
 ```bash
 sietch dedup stats                     # Show deduplication statistics
 sietch dedup gc                        # Run garbage collection
@@ -120,27 +135,31 @@ sietch scaffold [flags]                # Create vault from template
 ## Advanced Usage
 
 **View vault contents**
+
 ```bash
 sietch ls                              # List all files
 sietch ls docs/                        # List files in specific directory
 sietch ls --long                       # Show detailed information
 ```
 
 **Network synchronization**
+
 ```bash
 sietch discover                        # Find peers automatically
 sietch sync                            # Auto-discover and sync
 sietch sync /ip4/192.168.1.5/tcp/4001/p2p/QmPeerID  # Sync with specific peer
 ```
 
 **Sneakernet transfer**
+
 ```bash
 sietch sneak                           # Interactive mode
 sietch sneak --source /media/usb/vault # Transfer from USB vault
 sietch sneak --dry-run --source /backup/vault  # Preview transfer
 ```
 
 **Deduplication management**
+
 ```bash
 sietch dedup stats                     # Show statistics
 sietch dedup gc                        # Clean unreferenced chunks
@@ -168,26 +187,29 @@ sietch manifest
 ## Development
 
 ### Prerequisites
-* **Go 1.23+** – [Download](https://golang.org/dl/)
-* **Git** – Version control
+
+- **Go 1.23+** – [Download](https://golang.org/dl/)
+- **Git** – Version control
 
 ### Quick Development Setup
 
 1. **Clone and setup**
-    ```bash
-    git clone https://github.com/substantialcattle5/sietch.git
-    cd sietch
-    ./scripts/setup-hooks.sh
-    ```
+
+   ```bash
+   git clone https://github.com/substantialcattle5/sietch.git
+   cd sietch
+   ./scripts/setup-hooks.sh
+   ```
 
 2. **Verify installation**
-    ```bash
-    make check-versions
-    make build
-    make test
-    ```
+   ```bash
+   make check-versions
+   make build
+   make test
+   ```
 
 ### Available Commands
+
 ```bash
 make help            # List all commands
 make dev             # Format, test, build
@@ -203,13 +225,15 @@ For detailed development guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md).
 We welcome contributions of all kinds! Whether you're fixing bugs, adding features, improving documentation, or enhancing UX.
 
 **Quick contribution steps:**
+
 1. Fork the repository
 2. Create a feature branch: `git checkout -b feature/stillsuit`
 3. Make your changes following our [style guidelines](CONTRIBUTING.md#styleguides)
 4. Commit using [conventional commits](CONTRIBUTING.md#commit-messages)
 5. Push and open a Pull Request
 
 See our [Contributing Guide](CONTRIBUTING.md) for detailed information about:
+
 - Development environment setup
 - Code style guidelines
 - Testing requirements
@@ -218,9 +242,10 @@ See our [Contributing Guide](CONTRIBUTING.md) for detailed information about:
 ## Inspiration & Credits
 
 Sietch draws inspiration from:
-* **Syncthing** - Decentralized file synchronization
-* **IPFS** - Content-addressed storage
-* **Obsidian Sync** - Seamless cross-device syncing
+
+- **Syncthing** - Decentralized file synchronization
+- **IPFS** - Content-addressed storage
+- **Obsidian Sync** - Seamless cross-device syncing
 
 Built with ❤️ in Go by the open source community.
 
@@ -267,6 +292,13 @@ Thanks to all our amazing contributors!
                     <sub><b>Abhinav Garg</b></sub>
                 </a>
             </td>
+            <td align="center">
+                <a href="https://github.com/Janmesh23">
+                    <img src="https://avatars.githubusercontent.com/u/183159485?v=4" width="100;" alt="Janmesh23"/>
+                    <br />
+                    <sub><b>Janmesh </b></sub>
+                </a>
+            </td>
             <td align="center">
                 <a href="https://github.com/Akash29g">
                     <img src="https://avatars.githubusercontent.com/u/77738997?v=4" width="100;" alt="Akash29g"/>
@@ -308,4 +340,4 @@ Licensed under the **MIT License** – see the [LICENSE](LICENSE) file for detai
 
 ---
 
-> *"When you live in the desert, you develop a very strong survival instinct."* – Chani, *Dune*
+> _"When you live in the desert, you develop a very strong survival instinct."_ – Chani, _Dune_