aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 23 insertions, 2 deletions
diff --git a/README.md b/README.md
index 06e7209..a248236 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,23 @@
-# tamtam-go
-Go API for TamTam bots
+# TamTam Go
+
+Простая реализация клиента к TamTam Bot API на Go.
+
+На данном этапе представляет собой 1 в 1 реализованные методы API + HTTPHandler для веб-хуков + сгенерированные модели.
+
+## Документация
+
+Её пока нет :)
+
+Но http://godoc.org/github.com/neonxp/tamtam-go/ может вам помочь.
+
+## Статус
+
+API пока крайне неставбильное и обязательно будет меняться в будущем. Учитывайте это!
+
+## Пример
+
+Простые примеры использования находятся в директории `examples`.
+
+## Автор
+
+Alexander Kiryukhin <a.kiryukhin@mail.ru>