Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
500Foods authored Jun 14, 2024
1 parent eab895c commit b175355
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions elements/007-nitrogen/nitro/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,19 @@ There are lots of bits and pieces here that make up the core of both hydrogen an

This is a prototype really, test that it works, doesn't crash, no memory leaks, that sort of thing. And then use it in
other projects by basically duplicating this work or whatever pieces are needed.

## Additional Notes
- Makefile is provided
- Uses jansson for dealing with JSON
- Uses libwebsockets for dealing with websockets
- Native mDNS code (no library used)
- Includes Base64 encode/decode
- Websockets, mDNS announcer, and mdNS responder all in separate threads
- Exits cleanly with Ctrl+C
- No memory leaks detected at this stage
- JWT and Webscokets code are primarily stubs but some bits work
- TXT record in mDNS broadcast has everything hydrogen or HA might need
- Sends goodbye packets so when not running, mDNS caches should be cleared
- Tries really hard to be smart about IP addresses
- Tested with IPv4, but code is there for IPv6 - untested though

0 comments on commit b175355

Please sign in to comment.