Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aulolua authored Aug 7, 2023
1 parent 8e976a8 commit eb4d47d
Showing 1 changed file with 60 additions and 2 deletions.
62 changes: 60 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,60 @@
# discord-message-read-checker
as you can read on title , thanks to @janmakur
Apologies for the oversight. Let me update the headings as requested:

# MessageSeenTracker

![GitHub](https://img.shields.io/github/license/aulolua/MessageSeenTracker)

MessageSeenTracker is an open-source program inspired by the project by janmakur. It allows users to check if another user has seen their message. The logic behind this is that it hosts an HTTP server, and the client needs to send a message with the link of that HTTP server. The link is tunneled via Cloudflare using `cloudflared.msi`, which the user is required to install from [github.com/cloudflare/cloudflared releases](https://github.com/cloudflare/cloudflared/releases).

## Build Yourself

Before using MessageSeenTracker, you need to have the following installed on your machine:

- [Node.js](https://nodejs.org) - JavaScript runtime to execute the Node.js code.
- [cloudflared.msi](https://github.com/cloudflare/cloudflared/releases) - Cloudflare's command-line client.

### Build Instructions

1. Clone the repository from GitHub:

```bash
git clone https://github.com/aulolua/MessageSeenTracker.git
cd MessageSeenTracker
```

2. Run the HTTP server:

```bash
node server.js
```

3. Share the link to the HTTP server with the recipient to send them a message.

## Installation

You can find the latest Windows release under the [Releases](https://github.com/aulolua/MessageSeenTracker/releases) section. Download the `win32.exe` file and run it on your Windows machine to use MessageSeenTracker without any additional setup.

## Contributing

We welcome contributions to improve MessageSeenTracker and make it more efficient. If you'd like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch: `git checkout -b feature/your-feature-name`.
3. Commit your changes: `git commit -am 'Add some feature'`.
4. Push the branch to your fork: `git push origin feature/your-feature-name`.
5. Submit a pull request with a detailed description of your changes.

## License

MessageSeenTracker is released under the [MIT License](LICENSE).

## Disclaimer

MessageSeenTracker is an open-source project and comes with no warranties or guarantees. The authors are not responsible for any misuse or damages caused by the software. Use it at your own risk.

## Credits

- [janmakur](https://github.com/janmakur) - For the original project idea and inspiration.
- [aulolua](https://github.com/aulolua) - Maintainer of this project.

If you have any questions, feedback, or issues, feel free to open an issue on the GitHub repository. We appreciate your interest and hope you find MessageSeenTracker useful!

0 comments on commit eb4d47d

Please sign in to comment.