diff --git a/README.md b/README.md index 67e2a77..f56c35a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,45 @@ -# mario-dns +# Mario DNS tool -Tool for resolving domain names with web interface and API. Meshname/meship supported. \ No newline at end of file +[![Download Mario DNS tool](https://a.fsdn.com/con/app/sf-download-button)](https://sourceforge.net/projects/mario-dns/files/latest/download) + +Tool for resolving domain names with web interface and API. Meshname / meship supported. + +C++, Qt5 + +### For what? + +The main use of the tool is to translate IPv6 addresses to meship domains for use in services without IPv6 support. Meship (and meshname) domains are resolved by [meshnamed](https://github.com/zhoreeq/meshname). + +Also, the tool can be used as a supplement to projects that need to resolve domain names to addresses with some API. Mario DNS provides API with output in JSON format: + +``` +# Request: +dns.acetone.ygg + +# Answer: +{ + "status": true, + "answer": [ + "324:71e:281a:9ed3::53" + ] +} +``` + +You can use `version` request for version information. + +To use the API, send a domain or address to a socket without additional headers. + +### How to start + +Pass address and port to bind via parameters: + +``` +./mario-dns 192.168.0.1 5000 +``` + +Several options are supported, which must be specified after the port: + +- `--no-api` disable API access (only HTTP mode for web browser); +- `--no-http` disable HTTP access (only API mode); +- `--no-resolve` disable DNS resolving (only meship domains); +- `--no-favicon` disable web page favicon (-135KB for faster loading). \ No newline at end of file