Roadmap to first release

[Owez]

This issue is a roadmap/plan for development for the first release of torro. Below is a checklist-type list of overarching features to implement and issues (if any) linked to each.

These are not the "Objectives" set on the README.md file, just other goals to work towards.

Primary development objectives

• Bencode Parsing: parsing of bencoded .torrent files, not user-facing
  • Check lexographical order for dictionaries #14
  • Real-world .torrent tests for bencode parser #12
  • Remove references to char and str in bencode parser #8
  • Streamline parser & reduce use of peeking #4
  • Make strings into &[u8] #3
  • Bencode Dicts #2
  • Bencode Lists #1
• Torrent::new method: A simple function that uses bencode parsing to create a simple Torrent struct for interacting with various parts of the library, user-facing
  • Finishing Torrent::new parsing #16
• Tracker protocol: A (typically) UDP-connected module for easy uplink to given tracker, not user-facing
  • UDP Tracker vs GET Tracker #22
  • Basic implementation of tracker_udp.rs #23
• P2P protocol: TCP (most likely not the alternative uTP) backend file downloading, not user-facing
• Torrent::download method: An easily accessible function attached to the Torrent struct which allows downloading of torrent instance using previous "Tracker protocol" and "P2P protocol" implementations
• Seeding: Future seeding efforts

Misc objectives

Other objectives that cannot be set in order or marked with a checkbox, just items to finish to a deemed quality before release.

• Beginner-friendly docs
  • Beginner-friendly docs #18
• More examples
  • OTorrent client example #21 (see discussion if this should be a objective)