diff --git a/README.md b/README.md index 88c6f6f..bbe8208 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,16 @@ A teeworlds network protocol library, designed according to sans I/O (http://sans-io.readthedocs.io/) principles +## install + +```bash +pip install twnet_parser +``` + ## sample usage ```python -packet = parse(b'\x04\x0a\x00\xcf\x2e\xde\x1d\04') # 0.7 close +import twnet_parser.packet +packet = twnet_parser.packet.parse(b'\x04\x0a\x00\xcf\x2e\xde\x1d\04') # 0.7 close print(packet) # => : {'version': '0.7', 'header': , 'messages': []} print(packet.header) # => : {'flags': close ``` -## install - -```bash -pip install twnet_parser -``` - ## development setup ```bash