Skip to content

Commit 7e062f4

Browse files
committed
[MZ] Updated README.md for public release
1 parent 53df120 commit 7e062f4

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# zoe_challenge
1+
# Python UDP server using asyncio
2+
3+
This small project comprises a simple Python UDP server plus Dockerfile, as well as a (hopefully) useful Makefile and unittests.
4+
5+
The server makes use of the `asyncio` library to allow for asynchronous request handling.
26

37
## Prerequisites
48

@@ -80,14 +84,16 @@ Send a message and hit enter:
8084

8185
Using the `Makefile` you can run `make <cmd>` where `<cmd>` is one of:
8286

83-
* `sort-imports` to ensure Python imports are in the correct PEP format
84-
* `format` to format Python files using black
85-
* `type-check` to run `mypy` static type checking
87+
* `sort-imports` to ensure Python imports are in the correct PEP format/order
88+
* `format` to format Python files using `black`
89+
* `type-check` to run static type checking using `mypy`
8690
* `test` to run unittests using `pytest`
87-
* `all` to run all the above steps
88-
89-
or just type `make`/`make all`, which will run all of the above.
91+
* `all` to run all steps (or just type `make`)
9092

9193
## Authors
9294

9395
* Manuel Zander
96+
97+
## Acknowledgments
98+
99+
Many thanks to [julvo](https://github.com/julvo) for a review and some great suggestions during development of this software! 😊

0 commit comments

Comments
 (0)