feature(README): add gif header

.dockerignore

@@ -2,3 +2,4 @@ firmware.bin
 venv
 .ipynb_checkpoints
 main.py
+dist

Makefile

@@ -1,3 +1,6 @@
+.DEFAULT_GOAL := build-compile
+
+build-compile: build compile
 
 erase:
 	./venv/bin/esptool.py --chip esp32 --port /dev/ttyUSB0 erase_flash
@@ -28,3 +31,15 @@ compile-and-shell: compile-and-flash shell
 
 shell:
 	picocom /dev/ttyUSB0 -b115200
+
+build-and-upload: build upload
+
+build:
+	rm -rf src/dist/*.tar.gz*
+	cd src && python setup.py sdist
+
+upload:
+	twine upload src/dist/*.tar.gz
+
+generatecligif:
+	docker run --rm -i -t -u $$(id -u) -v $(CURDIR):/data asciinema/asciicast2gif -w 116 -h 20 images/service-discovery.rec images/service-discovery.gif

README.md

@@ -2,6 +2,8 @@
 
 [![PyPi](https://img.shields.io/pypi/v/micropython-mdns) ![MIT licensed](https://img.shields.io/pypi/l/micropython-mdns)](https://pypi.org/project/micropython-mdns/)
 
+![Image showing service discovery](images/service-discovery.gif)
+
 A pure Python implementation of [MDNS](https://tools.ietf.org/html/rfc6762) and the [Service Discovery](https://tools.ietf.org/html/rfc6763) protocol over MDNS 
 for [MicroPython](https://micropython.org/).
 

images/service-discovery.rec

@@ -0,0 +1,20 @@
+{"version": 2, "width": 226, "height": 49, "timestamp": 1609886641, "env": {"SHELL": "/usr/bin/zsh", "TERM": "xterm-256color"}}
+[0.582018, "o", ">>> "]
+[1.0, "o", "discovery.query('_googlecast', '_tcp')\r\n"]
+[1.1, "o", ">>> "]
+[1.5, "o", "loop.run_forever()\r\n"]
+[1.959639, "o", "Service added: <ServiceResponse name=Chromecast-Audio-Bx8E7Y0Xu8Z0Wxo7qGvO2ftR4d._googlecast._tcp.local priority=0 weight=0 target=bc0af14a-b274-2429-d7dd-3c4442c48fd3.local port=8009 ips={'192.168.100.160'} txt={'md': ['Chromecast Audio'], 'ic': ['/"]
+[1.981583, "o", "setup/icon.png'], 'st': ['0'], 'fn': ['My Room Speaker'], 'bs': ['FA8FCA8AEB47'], 'id': ['Bx8E7Y0Xu8Z0Wxo7qGvO2ftR4d'], 'rm': ['A0CBAE4DDB043C91'], 'cd': ['D0A879C453C3645BEAC1'], 've': ['05'], 'nf': ['1'], 'rs': [''], 'ca': ['2345"]
+[1.982018, "o", "60']}>\r\n"]
+[2.007527, "o", "Service added: <ServiceResponse name=Nest-Audio-SIhQR5iPhwYPBcad1I28FZng0Wi._googlecast._tcp.local priority=0 weight=0 target=99dae941-ac16-35ba-3c78-93794c211a49.local port=8009 ips={'192.168.100.235'} txt={'md': ['Nest Audio'], 'ic': ['/setup/icon.p"]
+[2.028095, "o", "ng'], 'st': ['0'], 'fn': ['Living Room Speaker'], 'bs': ['FA8FCA73718E'], 'id': ['SIhQR5iPhwYPBcad1I28FZng0Wi'], 'rm': [''], 'cd': ['559F4A27CD7300AF02D755EBA0FC89BD'], 've': ['05'], 'nf': ['1'], 'rs': [''], 'ca': ['12345']}>\r\n"]
+[2.05249, "o", "Service added: <ServiceResponse name=Pioneer-SX-S30DAB-959b5dc6dc6418ef8c88f34bf6fb3e34._googlecast._tcp.local priority=0 weight=0 target=959b5dc6-dc64-18ef-8c88-f34bf6fb3e34.local port=8009 ips={'192.168.100.152'} txt={'rm': ['F197DF1509494C5E'], 'ca': ['"]
+[2.069846, "o", "2052'], 'md': ['Pioneer SX-S30DAB'], 'ic': ['/setup/icon.png'], 'bs': ['0209B0BC051F'], 'rs': [''], 'id': ['959b5dc6dc6418ef8c88f34bf6fb3e34'], 'fn': ['Wohnzimmer Pioneer'], 'st': ['0'], 've': ['05']}>\r\n"]
+[2.09476, "o", "Service added: <ServiceResponse name=Google-Home-Mini-X70nvURaywFeSU3siSl11kSXtZM._googlecast._tcp.local priority=0 weight=0 target=74d94d3d-8325-69ee-f5cf-c08d901e3bd3.local port=8009 ips={'192.168.100.179'} txt={'md': ['Google Home Mini'], 'ic': ['/"]
+[2.115102, "o", "setup/icon.png'], 'st': ['0'], 'fn': ['My Bedroom'], 'bs': ['FA8FCA970CFB'], 'id': ['X70nvURaywFeSU3siSl11kSXtZM'], 'rm': [''], 'cd': ['6F574E0F81E68FF936FA706751C4BF66'], 've': ['05'], 'nf': ['1'], 'rs': [''], 'ca': ['12345']}>\r\n"]
+[3.885758, "o", "Service added: <ServiceResponse name=Google-Cast-Group-4d98b33fadad495aab96bb353708a03e-1._googlecast._tcp.local priority=0 weight=0 target=9d1dae8f-cd19-e3bd-849f-c63c3460ed0a.local port=32031 ips={'192.168.100.175'} txt={'md': ['Google Cast Group'], 'ic'"]
+[3.906378, "o", ": ['/setup/icon.png'], 'st': ['0'], 'fn': ['Ground Floor'], 'bs': ['FA8FCAACCE63'], 'id': ['4d98b33f-adad-495a-ab96-bb353708a03e'], 'rm': [''], 'cd': ['4d98b33f-adad-495a-ab96-bb353708a03e'], 've': ['05'], 'nf': ['1'], 'rs': [''], 'ca': ['198692']}>\r\n"]
+[3.935518, "o", "Service added: <ServiceResponse name=Lenovo-Smart-Display-9d1dae8fcd19e3bd849fc63c3460ed0a._googlecast._tcp.local priority=0 weight=0 target=9d1dae8f-cd19-e3bd-849f-c63c3460ed0a.local port=8009 ips={'192.168.100.175'} txt={'md': ['Lenovo Smart Display 10']"]
+[3.956431, "o", ", 'ic': ['/setup/icon.png'], 'st': ['0'], 'fn': ['Kitchen'], 'bs': ['FA8FCAACCE63'], 'id': ['9d1dae8fcd19e3bd849fc63c3460ed0a'], 'rm': [''], 'cd': ['93895C9D3D675D63C1F86FBB70D6'], 've': ['05'], 'nf': ['1'], 'rs': [''], 'ca': ['12345']}>\r\n"]
+[3.981508, "o", "Service added: <ServiceResponse name=Chromecast-53d0TiBaGzbYMOvHEz7k7fsGFQzm0VAz._googlecast._tcp.local priority=0 weight=0 target=6c1db7bb-cec7-6672-b9da-b6d78514f8d5.local port=8009 ips={'192.168.100.176'} txt={'md': ['Chromecast'], 'ic': ['/setup/icon.p"]
+[4.002117, "o", "ng'], 'st': ['1'], 'fn': ['TV Living Room'], 'bs': ['A43FE9478E01B3'], 'id': ['53d0TiBaGzbYMOvHEz7k7fsGFQzm0VAz'], 'rm': [''], 'cd': ['1FDC094B014FC12BD9F'], 've': ['05'], 'nf': ['1'], 'rs': ['Casting: Netflix'], 'ca': ['1234']}>\r\n"]