add documentation

README.md

@@ -8,20 +8,31 @@ A Python library that announces a server to a host.
 pip install announce-server
 ```
 
+## Development
+
+To install the developer dependencies required for testing and publishing:
+```bash
+pip install -e .[dev,pub]
+```
+
 ## Build
 To build the package, run:
 
 ```bash
-pip install -e .[dev]
-pip install -m build
+rm -rf dist/ build/ .eggs/ .pytest_cache/ src/announce_server.egg-info/
+python -m build --sdist --wheel
+```
+
+To publish:
+```bash
+twine upload dist/*
 ```
 
 ## Test
 
-To run the tests, install the package with the `[dev]` option:
+To run the tests, call:
 
 ```bash
-pip install -e .[dev]
 pytest
 ```
 
@@ -30,7 +41,7 @@ pytest
 ```python
 from announce_server.announce import announce_server
 
-@announce_server(name="server_name", ip="server_ip", port=8000, host_ip="host_server_ip", host_port=5000)
+@announce_server(name="server_name", ip="server_ip", port=8000, host_ip="host_server_ip", host_port=5000, retry_interval=5)
 def your_function():
     pass
 

setup.cfg

@@ -31,13 +31,16 @@ where = src
 
 [options.extras_require]
 dev =
-    build
-    setuptools_scm
     pytest
     pytest-mock
     pytest-asyncio
     pytest-cov
-    # asynctest; python_version<'3.8'
+
+pub =
+    build
+    wheel
+    setuptools_scm
+    twine
 
 [coverage:run]
 source = announce_server