tweak README
[pdns-pipe-nmc.git] / README.md
1 % Namecoin pipe backend for PowerDNS
2
3 ```
4 Copyright (c) 2014 Eugene Crosser
5
6 This software is provided 'as-is', without any express or implied
7 warranty. In no event will the authors be held liable for any damages
8 arising from the use of this software.
9
10 Permission is granted to anyone to use this software for any purpose,
11 including commercial applications, and to alter it and redistribute it
12 freely, subject to the following restrictions:
13
14     1. The origin of this software must not be misrepresented; you must
15     not claim that you wrote the original software. If you use this
16     software in a product, an acknowledgment in the product documentation
17     would be appreciated but is not required.
18
19     2. Altered source versions must be plainly marked as such, and must
20     not be misrepresented as being the original software.
21
22     3. This notice may not be removed or altered from any source
23     distribution.
24 ```
25
26 ------------------------------------------------------------------------
27
28 # Namecoin pipe backend for PowerDNS
29
30 There exists a [project](https://github.com/namecoin/nmcontrol) to
31 create an all-in-one tool that can, among other things, act as a DNS
32 server for the `.bit` zone. There is also a
33 [tool](https://github.com/namecoin/NamecoinToBind) for offline
34 conversion of namecoin data into BIND zone file.
35
36 Unlike that, this project is a single-purpose tool acting as a (real
37 time) bridge between [Namecoin](https://namecoin.org/) and DNS.
38 [PowerDNS](https://www.powerdns.com/) provides a stable DNS frontend,
39 with an easy to implement backend interface, which is used in this
40 project.
41
42 ## Status
43
44 Alpha. It does not handle `SRV` records at all, does not support
45 `delegate` (not to mention `import`), provides bogus version in the
46 `SOA` record, and is largely untested. Try at your risk.