Improved documentation

[TimonPost]

There are often questions around the problems people are facing because they don't know the fact that they should send packets at a consistent rate. And questions when to use our protocol. I hope that with this it is a bit more clear.

[kstrafe]

I think a lot of this needs to be rewritten. The user only needs to know:

• Packets are re-sent when you send a reliable packet
• A connection times out if there has not been a packet from/to that connection in 5s (default), so you need to use heartbeats

[TimonPost]

Kind of true, I think it is important to tell the exact purpose of where laminar is designed for. Every time we make a redit post, people will start asking the same questions and will refer to the same things. The same in our discord. There already have been 4 cases when people used laminar wrong. The same goes for the reliablity aspect of laminar. People somehow want to use laminar for file transfer.

There are two things we can do

1. Make this more detailed and short
2. Move some of this explanation to our book, which I think is more preferable than having all the text in the readme. And by doing that we keep the information in the readme short.

[jstnlef]

This needs a cargo fmt

[jstnlef]

I'm not entirely positive people will go look at the book to solve usage issues. (I know I haven't heh.) I think it would be worth putting the common issues someone would likely run into right in the README.

[TimonPost]

Alright, so we can agree that at least there must be info on common misinterpreted thinks about laminar. Then the question is, do we want it to be detailed, or do we want it to be very short, as @BourgondAries proposed?

[jstnlef]

I think it should be as detailed as it needs to be for people to but less likely to make the mistakes we've been seeing in the future.

[jstnlef]

Took a quick look at this and I have a few comments and more I'll flesh out into tomorrow. Mostly just some wording issues. Will post a proper review soon.

[TimonPost]

Is soon any time soon? Otherwise, I'll merge this and it can be done in the future. It is open for way to long meanwhile people might need it.

[TimonPost]

Worked through your comments, thanks for those!

[jstnlef]

Round 2

[jstnlef]

Also clippy is failing

error[E0716]: temporary value dropped while borrowed

   --> src/net/socket.rs:235:52

    |

235 |           let mut processed_packets: Vec<Outgoing> = connection

    |  ____________________________________________________^

236 | |             .gather_dropped_packets()

    | |_____________________________________^ creates a temporary which is freed while still in use

...

249 |               .collect();

    |                         - temporary value is freed at the end of this statement

...

259 |           processed_packets.push(processed_packet);

    |           ----------------- borrow later used here

    |

    = note: consider using a `let` binding to create a longer lived value


error: aborting due to previous error


For more information about this error, try `rustc --explain E0716`.

error: Could not compile `laminar`.


To learn more, run the command again with --verbose.

Terminated

script returned exit code 101

[TimonPost]

Alright, updated this PR again, any more comments?

[jstnlef]

Seems fine. We can always update it more in the future. 👍

[TimonPost]

Awesome, thanks for your review comments