First Commit

1 files changed, 35 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8c6e9ba
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# easy-tg
+
+Easy-to-use helpers for TDLib JSON.
+
+**Not completely tested yet.**
+
+## Dependencies
+
+* tdlib
+
+* json-c
+
+* pthread (if you compile with `TG_ENABLE_PTHREAD`)
+
+## Functions
+
+* Automatically handles authorization state changes.
+
+* Various helper functions.
+
+## Supported platforms
+
+* Any platform that `json-c` supports,
+
+* Any platform that `tdjson` supports, and
+
+* Any platform that supports C99.
+
+## How to use
+
+See `example.c`. Put your API keys into `build` then run it.
+
+## License
+
+Copyright Yuuta Liang, Apache 2.0. Originally published at https://git.yuuta.moe/easy-tg.git