aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..de191c6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# php-fastdns
+
+Клиент к FastVPS DNS API. Позволяет создавать, редактировать, удалять домены и записи.
+
+Полезно для автоматизации, если у вас много доменов/поддоменов.
+
+## Использование
+
+```php
+$fastdns = new FastDNS();
+try {
+ // авторизуемся
+ $fastdns->auth('ВАШ ТОКЕН');
+
+ // готово
+ // для примера, получим список доменов
+ $domains = $fastdns->getDomains();
+ var_dump($domains);
+} catch (FastDNSException $e) {
+ // что-то пошло не так
+}
+```
+
+Все доступные методы и параметры смотрите в классе, он простой.
+
+## Лицензия
+
+BSD-2c