peerkat

README

Peerkat

Peerkat is a peer-to-peer file sharing and chat application example that allows users to easily share files and chat. Also see the Peerkat Relay repository.

Table of Contents

1. Installation
2. Usage
3. Key Features
4. Contribution
5. License

Installation

To use the Peerkat application, you can follow the steps below:

Clone the repository:

    git clone git@github.com:yplog/peerkat.git

Install the dependencies:

    go mod tidy

Build the application:

    go build -o peerkat cmd/peerkat/main.go

Usage

Using the Peerkat application is straightforward. You can follow these steps:

Command line arguments:

    -help         Show help message
    -relay        Relay server address
    -mode         file-transfer/chat
    -peer         Peer address

Usage:

The -peer parameter is the address of the peer you want to connect to. Do not use if you are a first user.

    go run cmd/peerkat/main.go -relay <RELAY_ADDRESS> -mode <MODE>

    go run cmd/peerkat/main.go -relay <RELAY_ADDRESS> -mode <MODE> -peer <PEER_ADDRESS>

Or build the application and run:

    ./peerkat -relay <RELAY_ADDRESS> -mode <MODE> -peer <PEER_ADDRESS>

Key Features

Peerkat offers users the following key features:

• Fast and Secure File Sharing: Share your files quickly and securely with other users.
• Peer-to-Peer Communication: Direct file transfer between users without the need for a server.
• Chat: Communicate with other users through the chat feature.

Contribution

If you want to contribute to the development of Peerkat, please follow these steps:

1. Fork this repository.
2. Add a new feature or fix a bug.
3. Create a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.