Z1woo

Amend README.md

Showing 1 changed file with 119 additions and 0 deletions
<!--
*** Thanks for checking out the Best-README-Template. If you have a suggestion
*** that would make this better, please fork the repo and create a pull request
*** or simply open an issue with the tag "enhancement".
*** Thanks again! Now go create something AMAZING! :D
***
***
***
*** To avoid retyping too much info. Do a search and replace for the following:
*** github_username, repo_name, twitter_handle, email, project_title, project_description
-->
<!-- PROJECT SHIELDS -->
<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->
<!-- ABOUT THE PROJECT -->
## About The Project
[![Product Name Screen Shot][product-screenshot]](https://t.me/z1wooDemoBot)
**Telegram bot is a very good tool. It has many excellent APIs, and has strong operability.
I made a simple robot, hoping to help you understand telegram robot.**
## https://t.me/z1wooDemoBot
<!-- GETTING STARTED -->
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
* telegram account
* Apply for a new bot from @BotFather
* MongoDB DataBase
### Installation
1. Clone the repo
```sh
git clone http://khuhub.khu.ac.kr/2020105575/TelegramBot.git
```
2. Install NPM packages
```sh
npm install
```
4. Enter your Bot Token in `app.js`
```JS
const token = 'ENTER YOUR token';
```
4. Enter your DateBaseURI in `config.js`
```JS
mongoURI: = 'ENTER YOUR DateBaseURI';
```
<!-- USAGE EXAMPLES -->
## Usage
**Use Node.js to run, add bot to telegram, you can check the specific usage.**
![example1][id1]
![example2][id2]
![example3][id3]
* _For more examples, please refer to the [Documentation](https://core.telegram.org/bots/api)_
<!-- ROADMAP -->
## Roadmap
See the [open issues](http://khuhub.khu.ac.kr/2020105575/TelegramBot/issues) for a list of proposed features (and known issues).
<!-- CONTRIBUTING -->
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
<!-- LICENSE -->
## License
Distributed under the MIT License. See `LICENSE` for more information.
<!-- ACKNOWLEDGEMENTS -->
## Acknowledgements
* [An introduction for developers](https://core.telegram.org/bots)
* [Node.js Telegram Bot API Examples](https://github.com/yagop/node-telegram-bot-api)
* [Telegram Bot API Document](https://core.telegram.org/bots/api)
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[product-screenshot]:./image/screenshot.png
[id1]: ./example/hy.jpg
[id2]: ./example/yf1.jpg
[id3]: ./example/yf2.jpg
\ No newline at end of file