Good things come to those who wait. - Work in Progress!

.▄▄ · ▄ •▄ ▄• ▄▌ ▐ ▄ ▄ •▄ 
         ▐█ ▀. █▌▄▌▪█▪██▌•█▌▐██▌▄▌▪     ^...^
             ▄▀▀▀█▄▐▀▀▄·█▌▐█▌▐█▐▐▌▐▀▀▄·    <_* *_>   
        ▐█▄▪▐█▐█.█▌▐█▄█▌██▐█▌▐█.█▌      \_/
 ▀▀▀▀ ·▀  ▀ ▀▀▀ ▀▀ █▪·▀  ▀
Experience True Privacy

Welcome to Skunk, a cutting-edge peer-to-peer communication platform that enables secure and private messaging with powerful encryption.

Homepage | Documentation

Features

🔒 Secure Communication

• End-to-End Encryption: Secure your messages with powerful encryption protocols.
• Secure communication over TOR: Leverage the anonymity network to enhance security.

🛡️ Advanced Security

• Keys: Usage of public / private keys for secure communication.

💬 Chat Management

• Invite: Easily invite others to your chat groups.
• Join/Leave: Seamless integration for joining or leaving chat groups.
• Sync: Keep your chats updated.

Quick Start Guide

Prerequisites

• Go (version 1.20)
• Tor (For contributers / version 0.4.6.10)

! Build from source description (in progress)

Installation

1. Clone the Skunk Repository

   git clone https://github.com/your-repo/skunk.git
   cd skunk

2. Install Dependencies

   go mod tidy

3. Run all tests

   go test ./...

! go build... (in progress)

Examples (in progress)

Creating and Managing Chats

• Create a Chat

  skunk chat create <chat-name>

• Invite Peers

  skunk chat invite <peer-username>

• Join a Chat

  skunk chat join <chat-name>

• Leave a Chat

  skunk chat leave <chat-name>

Contribution Guidelines

We adhere to the following coding standards for our Go projects:

• Effective Go: Guidelines for writing clear, idiomatic, and efficient Go code.
• Godoc: Conventions for documenting Go code using comments.
• Standard Go Project Layout: Recommended directory structure for Go projects to promote best practices and consistency.

By following these standards, we ensure that our codebase remains consistent, maintainable, and easy to understand for all team members.

License

Skunk is licensed under the GPL3 License.

PSA: This is a student project. We do not recommend using this software for sensitive data, as it may not provide the necessary level of security and confidentiality. To handle sensitive data, use alternative software instead.