From 7174ad30b18a0cc598ef1acd8aa43fe426398a6f Mon Sep 17 00:00:00 2001 From: Mahdi Dibaiee Date: Mon, 29 Jun 2015 03:24:41 +0430 Subject: [PATCH] documentation --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 05863bb..f28a7bf 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ for any bugs you find or any suggestions you have. npm install telegram-api ``` +The code is well documented. I'm trying to integrate JSDoc / ESDoc into our repository for an easy to access documentation. + # Example Take a look at [demo.js](https://github.com/mdibaiee/node-telegram-api/blob/master/demo.js). @@ -87,4 +89,4 @@ This will result in: - [ ] Location Type - [ ] Contact Type - [ ] Allow remote control of bots (TCP maybe) -- YOUR IDEAS! [Fill an issue](https://github.com/mdibaiee/node-telegram-api/issues) +- [ ] YOUR IDEAS! [Fill an issue](https://github.com/mdibaiee/node-telegram-api/issues)