Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Luyten-Orion authored Mar 17, 2024
1 parent 4b11cda commit 62cf520
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ assert res.ok.bytesRead == 10 # The ID, length and the data in the buffer

## Useful Notes
An empty packet with size 0 needs to be handled by the user currently,
in the example code, `if packetLength <= 0: return` is enough for
this to not have an effect.
`if packetLength <= 0: return` is enough to usually detect if a socket
has closed.

## To-Dos
- [ ] Work on better documentation, with more examples.
Expand All @@ -50,12 +50,10 @@ this to not have an effect.
- A W.I.P server is being made with this library so that more tests can be added.

## Completed Goals
- [x] Allow for `Socket` *or* `AsyncSocket` to be used in `network.nim`.

- [X] Rewrite code to avoid streams (unnecessary overhead).
- Look at `src/modernnet/buffer.nim` for this functionality.

## Unplanned/Scrapped
- Allow for the full API of encoding and decoding to be used even on sockets.
- I've decided that doing everything via `Buffer`s is much better as it allows for us to
handle errors more gracefully.
handle errors more gracefully.

0 comments on commit 62cf520

Please sign in to comment.