diff --git a/README.md b/README.md index db2a599..0105102 100644 --- a/README.md +++ b/README.md @@ -1 +1,39 @@ -# AdamAI \ No newline at end of file +# AdamAI + +[![Build Status](https://travis-ci.com/IAdamAi/AdamAI.svg?token=SzVqcxEhtJezzefm5yC1&branch=master)](https://travis-ci.com/IAdamAi/AdamAI) + +AdamAI is a chatbot to introduce people to Islam. Currently it has this main API repisotory which is deployed on Heroku. There is a [telegram bot](https://github.com/IAdamAi/AdamAI_telegram) in other repository which used this API to send responses. + +## Built With + +[Node Js](https://nodejs.org/en/) - Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine. + +## Contributing + +Please feel free to contribute to this project by creating an issue first and then sending a pull request against the issue. + +## Installation + +It requires [Node.js](https://nodejs.org/) to run. Install it from the link and then in order to set it up locally follow below steps: + +```sh +$ cd AdamAI +$ npm install +$ node app.js +``` + +## Future Roadmap: + +We are hoping AdamAI to be fully equiped with following feature in future: + +* Both text and voice connversation. +* Natural Language Processing (NLP) +* Machine Learning (ML) +* Question focused +* Realtime conversation +* User friendly +* Able to answer off-topic questions smartly + +## License + +MIT