Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dinde451 authored Apr 12, 2024
1 parent 7b778a5 commit 3c39a57
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# SunBear: Peer-to-Peer Messaging and File Transfer

SunBear is a simple peer-to-peer messaging and file transfer application built in C++ for Windows. It allows users to communicate and exchange files over a local network without the need for a centralized server.

## Features

- Send and receive text messages.
- Send and receive files of any type.
- Console-based user interface.
- No external dependencies required.

## Installation

Simply download the latest release from the [Releases](https://github.com/your_username/sunbear/releases) page.

## Usage

1. Extract the downloaded ZIP file to a location of your choice.
2. Open a command prompt and navigate to the extracted directory.
3. Run the executable `sunbear.exe`.
4. Follow the on-screen instructions to send or receive messages and files.

## License

This project is licensed under the Apache License 2.0.

## Contributing

Contributions are welcome!

## Acknowledgements

- This project is inspired by the need for privacy-focused communication tools.
- Special thanks to all Cinnamon bears, without them and their precious help this project would have been impossible.

0 comments on commit 3c39a57

Please sign in to comment.