未验证 提交 3df59c5d 编写于 作者: L lijiarui 提交者: GitHub

Update README.md (#2001)

- Add emoji for fun
- Add resources link
上级 021c2819
......@@ -8,7 +8,7 @@
[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-blue.svg)](https://www.typescriptlang.org/)
[![Gitter](https://badges.gitter.im/Chatie/wechaty.svg)](https://gitter.im/Chatie/wechaty?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
## Connecting Chatbots
## :hearts: Connecting Chatbots
Wechaty is a Conversational AI RPA Chatbot SDK for Wechat **Individual** Account which can help you create a bot in 6 lines of [JavaScript](https://GitHub.com/Wechaty/wechaty), [Python](https://GitHub.com/Wechaty/python-wechaty/), [Go](https://GitHub.com/Wechaty/go-wechaty/), and [Java](https://GitHub.com/Wechaty/java-wechaty/), with cross-platform support including [Linux, Windows, MacOS](https://github.com/wechaty/wechaty/actions?query=workflow%3ANPM), and [Docker](https://github.com/wechaty/wechaty/actions?query=workflow%3ADocker).
......@@ -17,7 +17,7 @@ Wechaty is a Conversational AI RPA Chatbot SDK for Wechat **Individual** Account
:book: <https://github.com/Wechaty/wechaty/wiki>
:whale: <https://hub.docker.com/r/zixia/wechaty>
## Voice of Developers
## :yum: Voice of Developers
> "Wechaty is a great solution, I believe there would be much more users recognize it." [link](https://github.com/Wechaty/wechaty/pull/310#issuecomment-285574472)
> &mdash; <cite>@Gcaufy, Tencent Engineer, Author of [WePY](https://github.com/Tencent/wepy)</cite>
......@@ -39,7 +39,7 @@ Wechaty is a Conversational AI RPA Chatbot SDK for Wechat **Individual** Account
See more at [Wiki:Voice Of Developer](https://github.com/Wechaty/wechaty/wiki/Voice%20Of%20Developer)
### Join Us
### :raising_hand: Join Us
Wechaty is used in many ChatBot projects by thousands of developers. If you want to talk with other developers, just scan the following QR Code in WeChat with secret code _wechaty_, join our **Wechaty Developers' Home**.
......@@ -47,13 +47,18 @@ Wechaty is used in many ChatBot projects by thousands of developers. If you want
Scan now, because other Wechaty developers want to talk with you too! (secret code: _wechaty_)
### Video playlist
### :book: Resource
Wechaty already held lots of talk in the past 4 yeare, you can click [Youtube Playlist](https://www.youtube.com/playlist?list=PL8hd9KDTdarDXf_Rxtr8meKhxtgcXMInh) to find all wechaty wonderful talk on youtube!
Wechaty already held lots of talk and got a lot of blogs in the past 4 years, here is all of the wechaty resouces:
You can also click [blog](https://wechaty.github.io/) to find all of the blog written by wechaty contributors.
- :video_camera: [Youtube Playlist: Watch all of talk video related with Wechaty](https://www.youtube.com/playlist?list=PL8hd9KDTdarDXf_Rxtr8meKhxtgcXMInh)
- :page_with_curl: [Full Docs](https://wechaty.js.org/)
- :bulb: [Blog: See how developers use wechaty building fantastic project!](https://wechaty.github.io/)
- :beginner: [Wechaty-Getting-Started:Wechaty Starter Project Template that Works Out-of-the-Box](https://github.com/wechaty/wechaty-getting-started)
- :tada: [Wechaty Contributor List: Thanks for their contribution!](https://github.com/wechaty/wechaty/wiki/Contributors)
- :gift: [Juzibot Support Wechaty: Know everything about Wechaty](https://github.com/juzibot/Welcome/wiki/Everything-about-Wechaty)
## The World's Shortest ChatBot Code: 6 lines of JavaScript
## :rocket: The World's Shortest ChatBot Code: 6 lines of JavaScript
```javascript
......@@ -72,12 +77,12 @@ This bot can log all messages to the console after login by scan.
You can find more examples from [Wiki](https://github.com/Wechaty/wechaty/wiki/Examples) and [Example Directory](https://github.com/Wechaty/wechaty/blob/master/examples/).
## Requirements
## :checkered_flag: Requirements
1. Node.js v12
1. `sudo apt-get install build-essential && sudo snap install shellcheck`
## Getting Started
## :triangular_flag_on_post: Getting Started
[![node](https://img.shields.io/node/v/wechaty.svg?maxAge=604800)](https://nodejs.org/)
......@@ -154,7 +159,7 @@ Learn more about Wechaty Puppet from the Puppet Wiki:
1. Puppet Directory: <https://github.com/Wechaty/wechaty-puppet/wiki/Directory>
1. Puppet Compatibility: <https://github.com/Wechaty/wechaty-puppet/wiki/Compatibility>
## API
## :guitar: API
Read the Full Documentation at [Wechaty Official API Reference](https://wechaty.github.io/wechaty/)
......@@ -304,7 +309,7 @@ Accept room invitation
| method | [`date(): Promise<Date>`](https://wechaty.github.io/wechaty/#RoomInvitation+date) | the time it was created |
| method | `age(): Promise<number>` | the number of seconds since it has been created |
## TEST
## :eyeglasses: TEST
[![NPM](https://github.com/wechaty/wechaty/workflows/NPM/badge.svg)](https://github.com/wechaty/wechaty/actions?query=workflow%3ANPM)
[![Docker](https://github.com/wechaty/wechaty/workflows/Docker/badge.svg)](https://github.com/wechaty/wechaty/actions?query=workflow%3ADocker)
......@@ -321,20 +326,20 @@ npm test
Get to know more about the tests from [Wiki:Tests](https://github.com/Wechaty/wechaty/wiki/Tests)
## RELEASE NOTES
## :pencil: RELEASE NOTES
- [Latest Release](https://github.com/Wechaty/wechaty/releases/latest)(All releases [here](https://github.com/Wechaty/wechaty/releases))
- [Changelog](https://github.com/Wechaty/wechaty/blob/master/CHANGELOG.md)
### Views Since Feb 15, 2019
### :saxophone: Views Since Feb 15, 2019
[![HitCount](http://hits.dwyl.io/wechaty/wechaty.svg)](http://hits.dwyl.io/wechaty/wechaty)
## POWERED BY WECHATY
## :sparkling_heart: POWERED BY WECHATY
[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-brightgreen.svg)](https://github.com/Wechaty/wechaty)
### Wechaty Badge
### :sparkles: Wechaty Badge
```markdown
[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-brightgreen.svg)](https://github.com/Wechaty/wechaty)
......@@ -342,7 +347,7 @@ Get to know more about the tests from [Wiki:Tests](https://github.com/Wechaty/we
Get more embed html/markdown code from [Wiki:PoweredByWechaty](https://github.com/Wechaty/wechaty/wiki/PoweredByWechaty)
### Projects Using Wechaty
### :star2: Projects Using Wechaty
1. [一个用CNN深度神经网络给图片评分的wechaty项目](https://github.com/huyingxi/wechaty_selfie)
2. [Relay between Telegram and WeChat](https://github.com/Firaenix/TeleChatRelay)
......@@ -357,7 +362,7 @@ Pull Request is welcome to add yours!
Learn more about Projects Using Wechaty at [Wiki:PoweredByWechaty](https://github.com/Wechaty/wechaty/wiki/PoweredByWechaty)
## Find a Good Server
## :innocent: Find a Good Server
The best practice for running Wechaty Docker/NPM is using a VPS(Virtual Private Server) outside of China, which can save you hours of time because `npm install` and `docker pull` will run smoothly without any problem.
......@@ -370,11 +375,11 @@ The following VPS providers are used by the Wechaty team, and they worked perfec
| Korea | $10 | 1GB | Alipay, Paypal | [Netdedi](https://www.netdedi.com/?affid=35) |
| Singapore | $3.5 | 512MB | Alipay, Wechat | [Vultr](https://www.vultr.com/?ref=6986613) |
## See Also
## :notes: See Also
- [RelatedProject](https://github.com/Wechaty/wechaty/wiki/RelatedProject)
## The Story
## :poop: The Story
In 2017 ...
......@@ -389,7 +394,7 @@ So a tireless bot working for me 24x7 on wechat, monitoring/filtering the most i
At last, It's built for huan's personal study purpose of Automatically Testing.
## Contributors
## :two_hearts: Contributors
[![GitHub issues](https://img.shields.io/github/issues/wechaty/wechaty.svg)](https://github.com/Wechaty/wechaty/issues)
[![GitHub pull requests](https://img.shields.io/github/issues-pr/wechaty/wechaty.svg)](https://github.com/Wechaty/wechaty/pulls)
......@@ -399,7 +404,7 @@ At last, It's built for huan's personal study purpose of Automatically Testing.
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
[![Contribute](https://opencollective.com/wechaty/contributors.svg?width=890&button=false)](https://github.com/Wechaty/wechaty/graphs/contributors)
## Backers
## :sunglasses: Backers
[![Backers on Open Collective](https://opencollective.com/wechaty/backers/badge.svg)](#backers)
......@@ -407,7 +412,7 @@ Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com
[![Open Collective Wechaty](https://opencollective.com/wechaty/backers.svg?width=890)](https://opencollective.com/wechaty#backers)
## Sponsors
## :smirk: Sponsors
[![Sponsors on Open Collective](https://opencollective.com/wechaty/sponsors/badge.svg)](#sponsors)
......@@ -415,7 +420,7 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
[![Wechaty Sponsor](https://opencollective.com/wechaty/sponsor.svg?width=890)](https://opencollective.com/wechaty/#sponsor)
## Multi-language Wechaty
## :point_down: Multi-language Wechaty
[![Wechaty in Python](https://img.shields.io/badge/Wechaty-Python-blue)](https://github.com/wechaty/python-wechaty)
[![Wechaty in Kotlin](https://img.shields.io/badge/Wechaty-Kotlin-orange)](https://github.com/wechaty/java-wechaty)
......@@ -428,14 +433,14 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
- [Java Wechaty](https://github.com/wechaty/java-wechaty) - Java WeChaty Conversational AI Chatbot SDK for Wechat Individual Accounts (Java)
- [Scala Wechaty](https://github.com/wechaty/scala-wechaty) - Scala WeChaty Conversational AI Chatbot SDK for WechatyIndividual Accounts (Scala)
## Authors
## :raised_hands: Authors
1. [Huan](https://github.com/huan) [(李卓桓)](http://linkedin.com/in/zixia), Tencent TVP of Chatbot
1. [Rui (李佳芮)](https://pre-angel.com/peoples/jiarui-li/)
[![Profile of Huan LI (李卓桓) on StackOverflow](https://stackoverflow.com/users/flair/1123955.png)](https://stackoverflow.com/users/1123955/huan)
## Copyright & License
## :email: Copyright & License
- Code & Docs © 2016 Huan, Rui, and Wechaty Contributors
- Code released under the Apache-2.0 License
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册