readme and license

LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>

README.md

@@ -0,0 +1,54 @@
+# Avahi Aliases (CNAME)
+
+Add `CNAME` aliases to current Avahi host.
+
+Dependencies:
+ * Python 2.7
+ * python-avahi, python-pip
+
+## Installation
+
+```bash
+# apt-get install -y python-avahi python-pip
+# pip install --upgrade git+https://github.com/Dalee/avahi-cname-aliases.git
+```
+
+## Systemd configuration
+```
+[Unit]
+Description=Avahi Aliases stack
+Requires=avahi-daemon.service
+After=avahi-daemon.service
+
+[Service]
+ExecStart=/usr/local/bin/avahi-cname-aliases
+
+[Install]
+WantedBy=multi-user.target
+```
+
+```bash
+# systemctl daemon-reload
+# systemctl enable avahi-aliases
+# systemctl start avahi-aliases
+```
+
+## Set aliases
+
+```bash
+# mkdir /etc/avahi/aliases.d
+# echo "hello.local" > /etc/avahi/aliases.d/hello.txt
+# systemctl restart avahi-aliases
+```
+
+## Common pitfalls
+
+Avahi allows 32 CNAME aliases per group.
+
+In order to increase this value just tune `entries-per-entry-group-max` 
+value of `/etc/avahi/avahi-daemon.conf`.
+
+
+## License
+
+Code is unlicensed. Do whatever you want with it. [Set Your Code Free](http://unlicense.org/).