-
Notifications
You must be signed in to change notification settings - Fork 346
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #871 from nibble0101/what-is-wechaty
What is Wechaty sub-section of the Introduction section
- Loading branch information
Showing
2 changed files
with
143 additions
and
122 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| --- | ||
| title: What is Wechaty | ||
| --- | ||
|
|
||
| import ShortestChatbots from './polyglot/transclusions/shortest-chatbots.mdx' | ||
| import ProviderBadges from './puppet-providers/transclusions/badges.mdx' | ||
| import PolyglotBadges from './polyglot/transclusions/badges.mdx' | ||
|
|
||
| > A chatbot is a software application used to conduct an online chat conversation instead of direct contact with a live human agent. It is a type of software that can automate conversations and interact with people through messaging platforms. — [Wikipedia](https://en.wikipedia.org/wiki/Chatbot) | ||
| Wechaty is an [Open Source](https://opensource.com/resources/what-open-source) software application for building chatbots. It is a modern [Conversational](explainations/conversational.md) [RPA](explainations/rpa.md) SDK which Chatbot makers can use to create a bot in a few lines of code. | ||
|
|
||
| You can use Wechaty to build a chatbot which automates conversations and interact with people through instant messaging platforms such as [WhatsApp](https://www.whatsApp.com/?lang=en), [WeChat](https://www.wechat.com/), [WeCom](https://work.weixin.qq.com/), [Gitter](https://gitter.im/) and [Lark](https://www.larksuite.com/) among others. | ||
|
|
||
| ## Features {#features} | ||
|
|
||
| Wechaty offers out-of-the-box support for the common features you would need for turning your **Instant Messaging** account into a chatbot. You can easily customize and extend Wechaty to create a chatbot that is tailored to your needs. Some common features of Wechaty that you can take advantage of include: | ||
|
|
||
| - **Message processing**: You can use Wechaty to receive and send messages. It supports messages in the form of text, image, audio, video, and attachments. | ||
| - **Room management**: You can use it to create rooms, add and remove room members, manage topics, etc. | ||
| - **Contact management**: Search by name, alias, tags, get profile data and avatar. | ||
| - **Friendship management**: Search and add new friends and accept friendship requests. | ||
| - **Intelligent dialogue management**: Just several configuration can get a task-oriented bot. | ||
| - **Multi-platform support**: With Wechaty, you write code which runs on all IM platforms. | ||
|
|
||
| :::note API References | ||
|
|
||
| Learn more functions from [API Reference](./api/overview.mdx) and [How-to Guides](./howto/overview.mdx). | ||
|
|
||
| ::: | ||
|
|
||
| ## Supported Instant Messaging services | ||
|
|
||
| Wechaty supports a number of Instant Messaging platforms. You can build a chatbot using Wechaty for any of the following Instant Messaging platforms: | ||
|
|
||
| <ProviderBadges /> | ||
|
|
||
| ## Supported programming languages | ||
|
|
||
| The Wechaty community have developed **Software Development Kits** for most of the popular programming languages. You can build a Wechaty Chatbot in any of the programming languages listed below: | ||
|
|
||
| <PolyglotBadges /> | ||
|
|
||
| All these SDKs have been developed by and for the community. | ||
|
|
||
| ## Releases | ||
|
|
||
| Since its creation in 2016, a number of Wechaty versions have been released. For more information about the release history and the current stable version, you can read the [Wechaty release notes](https://github.com/Wechaty/wechaty/releases) on Github. | ||
|
|
||
| - [Latest Release](https://github.com/Wechaty/wechaty/releases/latest) | ||
| - [Changelog](https://github.com/Wechaty/wechaty/blob/master/CHANGELOG.md) | ||
|
|
||
| ## License | ||
|
|
||
| Wechaty is an [Open Source Project](https://opensource.com/resources/what-open-source). It is released under [Apache-2.0 license](https://github.com/wechaty/wechaty/blob/master/LICENSE) and the corresponding documentation is released under the [Creative Commons license](https://creativecommons.org/licenses/). | ||
|
|
||
| ## Maintainers | ||
|
|
||
| Wechaty is maintained by [Huan](https://github.com/huan), [Rui](https://github.com/lijiarui) and a community of [Open Source Contributors](https://wechaty.js.org/contributors/). We are always looking for people to join the Wechaty community to maintain the Wechaty codebase and documentation. You necessarily don't have to be a programmer to contribute to Wechaty. To get started contributing, you can read the [Contributing section](contributing/overview.md) of this documentation. | ||
|
|
||
| ## Getting help | ||
|
|
||
| Wechaty has a community of very helpful contributors on different platforms you can join to get help from. Before joining any of the communities, we recommend that you read our [Code of conduct](community/code-of-conduct.mdx) so that you adhere to our community guidelines. A full list of the different Wechaty communities can be accessed from the [Wechaty community](community/overview.mdx) section of this documentation. | ||
|
|
||
| ## Voice of developers {#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) | ||
| > — <cite>@Gcaufy, Tencent Engineer, Author of [WePY](https://github.com/Tencent/wepy)</cite> | ||
| > | ||
| > "太好用，好用的想哭" | ||
| > — <cite>@xinbenlv, Google Engineer, Founder of HaoShiYou.org</cite> | ||
| > | ||
| > "最好的微信开发库" [link](http://weibo.com/3296245513/Ec4iNp9Ld?type=comment) | ||
| > — <cite>@Jarvis, Baidu Engineer</cite> | ||
| > | ||
| > "Wechaty 让运营人员更多的时间思考如何进行活动策划、留存用户，商业变现" [link](http://mp.weixin.qq.com/s/dWHAj8XtiKG-1fIS5Og79g) | ||
| > — <cite>@lijiarui, Founder & CEO of Juzi.BOT.</cite> | ||
| > | ||
| > "If you know js ... try Wechaty, it's easy to use." | ||
| > — <cite>@Urinx Uri Lee, Author of [WeixinBot(Python)](https://github.com/Urinx/WeixinBot)</cite> | ||
| > | ||
| > "Wechaty is a good project, I hope it can continue! Therefore, I became a contributors in open collective." | ||
| > — <cite>[@Simple](https://github.com/mrwhh)</cite> | ||
| ## World's shortest chatbot {#shortest-chatbot} | ||
|
|
||
| You can build a chatbot with a minimum of 6 lines of code with Wechaty. | ||
|
|
||
| <ShortestChatbots /> | ||
|
|
||
| :::note Polyglot Wechaty | ||
|
|
||
| Read more codes from [Polyglot](./polyglot/overview.mdx). | ||
|
|
||
| ::: | ||
|
|
||
| ## Stargazers over time | ||
|
|
||
| [](https://starchart.cc/wechaty/wechaty) | ||
|
|
||
| ## Contributors | ||
|
|
||
| [](https://github.com/Wechaty/wechaty/issues) | ||
| [](https://github.com/Wechaty/wechaty/pulls) | ||
| [](https://opencollective.com/wechaty/) | ||
| [](https://opencollective.com/wechaty/) | ||
|
|
||
| [](https://sourcerer.io/fame/huan/wechaty/wechaty/links/0) | ||
| [](https://sourcerer.io/fame/huan/wechaty/wechaty/links/1) | ||
| [](https://sourcerer.io/fame/huan/wechaty/wechaty/links/2) | ||
| [](https://sourcerer.io/fame/huan/wechaty/wechaty/links/3) | ||
| [](https://sourcerer.io/fame/huan/wechaty/wechaty/links/4) | ||
| [](https://sourcerer.io/fame/huan/wechaty/wechaty/links/5) | ||
| [](https://sourcerer.io/fame/huan/wechaty/wechaty/links/6) | ||
| [](https://sourcerer.io/fame/huan/wechaty/wechaty/links/7) | ||
|
|
||
| This project exists thanks to all the people who contribute. | ||
|
|
||
| --- | ||
|
|
||
| [](https://github.com/Wechaty/wechaty/graphs/contributors) | ||
|
|
||
| ### Backers | ||
|
|
||
| [](#backers) | ||
|
|
||
| Thank you to all our backers! 🙏. [[Become a backer](https://opencollective.com/wechaty#backer)] | ||
|
|
||
| [](https://opencollective.com/wechaty#backers) | ||
|
|
||
| ### Sponsors | ||
|
|
||
| [](#sponsors) | ||
|
|
||
| Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/wechaty#sponsor)] | ||
|
|
||
| [](https://opencollective.com/wechaty/#sponsor) | ||
|
|
||
| ## Join us | ||
|
|
||
| Scan the following QRCode and reply with "wechaty" to join the home of Wechaty Developers. | ||
|
|
||
|  |