Skip to content

Commit

Permalink
Update the README (a bit)
Browse files Browse the repository at this point in the history
  • Loading branch information
jbkempf committed Oct 14, 2019
1 parent 52f1cee commit 49a5dd9
Showing 1 changed file with 22 additions and 4 deletions.
26 changes: 22 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,34 @@
microdns
========

microdns is an **mDNS** library, focused on being **simple** and **cross-platform**.

Minimal mDNS resolver (and announcer) library
---------------------------------------------

This is very early stage, use at your OWN risks.
This library **microdns** is still in development, and therefore can still have bugs.

The goal is to have a simple library to listen and create mDNS announces,
without the complexity of larger libraries like *avahi*.

This means that the API is quite *low-level* and that the code is in C.
Bindings to other languages are welcome.


License
-------

microdns is available under the LGPL license. People who want *(or need)* a commercial license can acquire one.


CoC
---

On our way to make it wayyy better :)
The [VideoLAN Code of Conduct](https://wiki.videolan.org/CoC) applies to this project.


Installation
------------
meson build && ninja -C build
meson builddir && ninja -C builddir

# ninja -C build install
# ninja -C builddir install

0 comments on commit 49a5dd9

Please sign in to comment.