Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/<your_torrent_file>.torrent
```

#### Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.
This project is licensed under the MIT License.
Loading