Showing
1 changed file
with
119 additions
and
0 deletions
README.md
0 → 100644
1 | +<!-- | ||
2 | +*** Thanks for checking out the Best-README-Template. If you have a suggestion | ||
3 | +*** that would make this better, please fork the repo and create a pull request | ||
4 | +*** or simply open an issue with the tag "enhancement". | ||
5 | +*** Thanks again! Now go create something AMAZING! :D | ||
6 | +*** | ||
7 | +*** | ||
8 | +*** | ||
9 | +*** To avoid retyping too much info. Do a search and replace for the following: | ||
10 | +*** github_username, repo_name, twitter_handle, email, project_title, project_description | ||
11 | +--> | ||
12 | + | ||
13 | + | ||
14 | + | ||
15 | +<!-- PROJECT SHIELDS --> | ||
16 | +<!-- | ||
17 | +*** I'm using markdown "reference style" links for readability. | ||
18 | +*** Reference links are enclosed in brackets [ ] instead of parentheses ( ). | ||
19 | +*** See the bottom of this document for the declaration of the reference variables | ||
20 | +*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. | ||
21 | +*** https://www.markdownguide.org/basic-syntax/#reference-style-links | ||
22 | +--> | ||
23 | + | ||
24 | + | ||
25 | +<!-- ABOUT THE PROJECT --> | ||
26 | +## About The Project | ||
27 | + | ||
28 | +[![Product Name Screen Shot][product-screenshot]](https://t.me/z1wooDemoBot) | ||
29 | + | ||
30 | + | ||
31 | +**Telegram bot is a very good tool. It has many excellent APIs, and has strong operability. | ||
32 | +I made a simple robot, hoping to help you understand telegram robot.** | ||
33 | + | ||
34 | +## https://t.me/z1wooDemoBot | ||
35 | + | ||
36 | +<!-- GETTING STARTED --> | ||
37 | +## Getting Started | ||
38 | + | ||
39 | +To get a local copy up and running follow these simple steps. | ||
40 | + | ||
41 | +### Prerequisites | ||
42 | + | ||
43 | +This is an example of how to list things you need to use the software and how to install them. | ||
44 | +* telegram account | ||
45 | +* Apply for a new bot from @BotFather | ||
46 | +* MongoDB DataBase | ||
47 | + | ||
48 | +### Installation | ||
49 | + | ||
50 | +1. Clone the repo | ||
51 | + ```sh | ||
52 | + git clone http://khuhub.khu.ac.kr/2020105575/TelegramBot.git | ||
53 | + ``` | ||
54 | +2. Install NPM packages | ||
55 | + ```sh | ||
56 | + npm install | ||
57 | + ``` | ||
58 | +4. Enter your Bot Token in `app.js` | ||
59 | + ```JS | ||
60 | + const token = 'ENTER YOUR token'; | ||
61 | + ``` | ||
62 | +4. Enter your DateBaseURI in `config.js` | ||
63 | + ```JS | ||
64 | + mongoURI: = 'ENTER YOUR DateBaseURI'; | ||
65 | + ``` | ||
66 | + | ||
67 | +<!-- USAGE EXAMPLES --> | ||
68 | +## Usage | ||
69 | + | ||
70 | +**Use Node.js to run, add bot to telegram, you can check the specific usage.** | ||
71 | +![example1][id1] | ||
72 | +![example2][id2] | ||
73 | +![example3][id3] | ||
74 | +* _For more examples, please refer to the [Documentation](https://core.telegram.org/bots/api)_ | ||
75 | + | ||
76 | + | ||
77 | + | ||
78 | +<!-- ROADMAP --> | ||
79 | +## Roadmap | ||
80 | + | ||
81 | +See the [open issues](http://khuhub.khu.ac.kr/2020105575/TelegramBot/issues) for a list of proposed features (and known issues). | ||
82 | + | ||
83 | + | ||
84 | + | ||
85 | +<!-- CONTRIBUTING --> | ||
86 | +## Contributing | ||
87 | + | ||
88 | +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**. | ||
89 | + | ||
90 | +1. Fork the Project | ||
91 | +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) | ||
92 | +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) | ||
93 | +4. Push to the Branch (`git push origin feature/AmazingFeature`) | ||
94 | +5. Open a Pull Request | ||
95 | + | ||
96 | +<!-- LICENSE --> | ||
97 | +## License | ||
98 | + | ||
99 | +Distributed under the MIT License. See `LICENSE` for more information. | ||
100 | + | ||
101 | + | ||
102 | +<!-- ACKNOWLEDGEMENTS --> | ||
103 | +## Acknowledgements | ||
104 | + | ||
105 | +* [An introduction for developers](https://core.telegram.org/bots) | ||
106 | +* [Node.js Telegram Bot API Examples](https://github.com/yagop/node-telegram-bot-api) | ||
107 | +* [Telegram Bot API Document](https://core.telegram.org/bots/api) | ||
108 | + | ||
109 | + | ||
110 | + | ||
111 | + | ||
112 | + | ||
113 | +<!-- MARKDOWN LINKS & IMAGES --> | ||
114 | +<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> | ||
115 | + | ||
116 | +[product-screenshot]:./image/screenshot.png | ||
117 | +[id1]: ./example/hy.jpg | ||
118 | +[id2]: ./example/yf1.jpg | ||
119 | +[id3]: ./example/yf2.jpg | ||
... | \ No newline at end of file | ... | \ No newline at end of file |
-
Please register or login to post a comment