From 5f85afaa827388b87c034fcb6318febff3ddac59 Mon Sep 17 00:00:00 2001 From: git-sudo-404 Date: Thu, 1 Oct 2026 18:51:44 +0530 Subject: [PATCH] added a README.md --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/README.md b/README.md index cff8d5c..428077c 100644 --- a/README.md +++ b/README.md @@ -1 +1,47 @@ ### GoTorrent Client + +- A bittorent client implementation from scratch in go lang. + +#### Here' How the repo is structured + +``` +. +├── cmd +│   └── main.go --> entrypoint for the GoTorrent +├── go.mod +├── internal +│   ├── bencode +│   │   ├── decoder_test.go +│   │   ├── decoder.go +│   │   ├── encoder_test.go +│   │   └── encoder.go +│   ├── torrent +│   │   ├── client.go +│   │   ├── messages.go +│   │   ├── metainfo.go +│   │   ├── metainfoParser_test.go +│   │   ├── metainfoParser.go +│   │   ├── torrent.go +│   │   ├── trackerRequest_test.go +│   │   └── trackerRequest.go +│   └── url-encoder +│   ├── urlencoder_test.go +│   └── urlencoder.go +├── LICENSE +├── README.md +└── testdata + └── ubuntu-26.04.1-desktop-amd64.iso.torrent --> Test .torrent file +``` + +#### How to run + +- Execute the following command after downloading a .torrent file and placing it under the testdata + +``` +go run cmd/main.go testdata/.torrent +``` + +#### Contributing + +Contributions are welcome! Feel free to open an issue or submit a pull request. +This project is licensed under the MIT License.