Merge pull request #1 from BroncoTc/master

Asked to write the readme files
This commit is contained in:
Denny Dai 2015-05-30 03:05:50 +08:00
commit b7a4b99225
2 changed files with 9 additions and 5 deletions

View File

@ -1,7 +1,10 @@
DennyDai/D-Bot
==============================
a php bot
A chat bot written in PHP
The aim is to design a Functional chat bot can support different messaging platforms and provide the same plugin API for plugin developers.
This project is now in a very early stage since Telegarm is the only supported platform and the API provided for developers are still limitied. I am still a greenhand in Object oriented programming, so if there's anything wrong with the code itself or with the design of the project please send me an issue. I am willing to publish better pieces of code.
Supported Chat Tools List
------------
==============================
[Telegram](https://telegram.org) - [README](https://github.com/dennydai/D-bot/blob/master/readmes/Telegram/Telegram.md)

View File

@ -1,11 +1,10 @@
DennyDai/D-Bot
==============================
a php bot
A PHP Chat Bot
Requirements
------------
- a running [telegram-cli](https://github.com/vysheng/tg/) listening on a unix-socket (`-S`) or a port (`-P`). Needs to be configured already (phone-number, etc.).
- A running [telegram-cli](https://github.com/vysheng/tg/) listening on a unix-socket (`-S`) or a port (`-P`). Needs to be configured (phone-number, etc.) before this progarm runs.
- php >= 5.3.0
Usage
@ -23,3 +22,5 @@ Finally,
chmod 0777 /tmp/tg.sck
If you never started telegram-cli before, you need to start it first in normal mode, so you can type in your telegram-phone-number and register it, if needed (`./bin/telegram-cli`).
If you are using this program under root permission and the telegram-cli failed to switch to 'telegramd', you can use "-U root" as one of the arguments.