Milestone tracking issue

[vimpunk]

Pre-alpha

• Perform a single in-memory download of a file with a single peer connection if given
  the address of a seed and the path to the torrent metainfo. No multiple
  torrents, no seeding, no optimizations, or any other feature you might expect
  from a full-fledged BitTorrent library.
• Extend previous addition with actually saving the downloaded file to disk after
  verification.
• Download a directory of files using a single peer connection.
• Download a torrent using multiple connections.
• Optimize download performance to use self-adjusting optimal request queue
  sizes and slow start mode for ramping up download throughput (see Optimize download performance #40).
  • Add request timeouts (Implement request timeouts #18)
  • Share a piece download (Share a piece download among peers #45)

Alpha release: 0.1.0

• Seed a torrent (Seed a torrent #50)
• Get peers from an HTTP tracker (HTTP trackers #51)
• Torrent's peer management (Torrent peer management #64)
• Simplified notification system + public API (Basic notification system and public API #52)
• Improved API docs (Document public API with usage examples #56)
• Update dependencies (tokio 0.3 in particular -- [update]: can't update tokio yet, see Update tokio when reqwest updates it #76)
• Decide whether to use simplified 0.x.y semver or with pre-release tag. Former is simpler, latter more correct (though the semver spec covers the 0.x.y use case) while being more complicated for little gain: we don't have parallel releases that rely on strict semver.
• Fix inconsistencies (import stye, namings, etc) and clippy lints
• Read cache upper bound (Disk read/write buffers upper bound #22) or remove entirely for mvp
• Basic TUI for CLI app (CLI app TUI #74)
• Use simple non-tui CLI binary for tests as it breaks seeding
• Cargo release
• Remove unused benches
• Link to docsrs in readme, and other fancy badges

0.1.x

• Make cross-platform (Make cross-platform #88)
• UDP tracker support (UDP trackers #97)
• License files (License files #91)

Priority

• DHT
• magnet links

Future features not yet scheduled

• persisting torrent metadata to continue them after restart
• disk-network IO backpressure to optimize performance and stability
• UPnP
• Fast Extension
• stream encryption
• uTP sockets
• file padding
• BT2.0
• rate limiting
• file priorities
• piece picking strategies (sequential, rarest first, other)
• make storage backend system agnostic/generic

[vimpunk]

Alpha (MVP) release scheduled

There is no point in developing this in hiding forever. Therefore, an MVP release is planned with a minimum feature set to make it remotely viable as a torrent engine.

This is likely going to be 1.0.0-alpha.x.

Updated milestones to reflect this.