Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

What is Wechaty sub-section of the Introduction section #871

Merged
merged 34 commits into from
Sep 9, 2021
Merged
Show file tree
Hide file tree
Changes from 31 commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
b8e198a
Improve Introduction and Explanation sections project: What is Wechat…
nibble0101 May 19, 2021
a8f0c6b
Replace non-existent links with placeholder ids
nibble0101 May 20, 2021
0ae3924
Merge branch 'master' into what-is-wechaty
nibble0101 May 20, 2021
3ae201b
Add suggested changes in the code reviews
nibble0101 May 24, 2021
39bc177
Merge branch 'what-is-wechaty' of github.com:nibble0101/wechaty.js.or…
nibble0101 May 24, 2021
8df9de3
Fix issues raised by @Rohitesh-Kumar-Jain in his review
nibble0101 Jul 8, 2021
8695f13
Merge branch 'master' into what-is-wechaty
lijiarui Jul 10, 2021
b194db1
Update what-is-wechaty.md
chris-4444 Jul 12, 2021
916920f
Merge branch 'master' into what-is-wechaty
nibble0101 Jul 12, 2021
dc00f68
Merge branch 'master' into what-is-wechaty
nibble0101 Jul 13, 2021
f76edd5
Merge branch 'master' into what-is-wechaty
nibble0101 Jul 19, 2021
4addb6a
Add links and convert some hypertexts to ordinary links
nibble0101 Jul 19, 2021
767afee
Merge branch 'master' into what-is-wechaty
nibble0101 Jul 30, 2021
baab718
Remove the original what-is-wechaty section from side bar
nibble0101 Jul 30, 2021
4c93c29
0.8.335
nibble0101 Jul 30, 2021
52cb466
Merge branch 'master' into what-is-wechaty
nibble0101 Aug 3, 2021
b41d82c
Merge original and new content on what is wechaty
nibble0101 Aug 3, 2021
fdfe70f
0.8.336
nibble0101 Aug 3, 2021
3f1662b
Integrate remote changes
nibble0101 Aug 3, 2021
0bc712e
Merge branch 'master' into what-is-wechaty
nibble0101 Aug 23, 2021
e864d55
Merge branch 'master' into what-is-wechaty
nibble0101 Sep 3, 2021
fd7e1fa
Add links
nibble0101 Sep 3, 2021
9922283
0.9.9
nibble0101 Sep 3, 2021
37cbe40
Add Wecom
nibble0101 Sep 3, 2021
6358d04
0.9.10
nibble0101 Sep 3, 2021
e2d0746
Merge branch 'master' into what-is-wechaty
nibble0101 Sep 6, 2021
1d4a07a
Merge branch 'master' into what-is-wechaty
nibble0101 Sep 6, 2021
51770fe
Merge branch 'master' into what-is-wechaty
nibble0101 Sep 7, 2021
044e750
Change spelling of WhatsApp, WeChat and Wecom
nibble0101 Sep 7, 2021
9db247a
Merge branch 'what-is-wechaty' of github.com:nibble0101/wechaty.js.or…
nibble0101 Sep 7, 2021
16f23d9
Merge branch 'master' into what-is-wechaty
nibble0101 Sep 7, 2021
b12cb13
Merge branch 'master' into what-is-wechaty
Rohitesh-Kumar-Jain Sep 9, 2021
e94f032
Merge branch 'master' into what-is-wechaty
nibble0101 Sep 9, 2021
2d10e80
Merge branch 'master' into what-is-wechaty
nibble0101 Sep 9, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 0 additions & 122 deletions docusaurus/docs/wechaty.md

This file was deleted.

143 changes: 143 additions & 0 deletions docusaurus/docs/wechaty.mdx
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)
> &mdash; <cite>@Gcaufy, Tencent Engineer, Author of [WePY](https://github.com/Tencent/wepy)</cite>
>
> "太好用,好用的想哭"
> &mdash; <cite>@xinbenlv, Google Engineer, Founder of HaoShiYou.org</cite>
>
> "最好的微信开发库" [link](http://weibo.com/3296245513/Ec4iNp9Ld?type=comment)
> &mdash; <cite>@Jarvis, Baidu Engineer</cite>
>
> "Wechaty 让运营人员更多的时间思考如何进行活动策划、留存用户,商业变现" [link](http://mp.weixin.qq.com/s/dWHAj8XtiKG-1fIS5Og79g)
> &mdash; <cite>@lijiarui, Founder & CEO of Juzi.BOT.</cite>
>
> "If you know js ... try Wechaty, it's easy to use."
> &mdash; <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."
> &mdash; <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

[![Stargazers over time](https://starchart.cc/wechaty/wechaty.svg)](https://starchart.cc/wechaty/wechaty)

## 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)
[![Open Collective Backers](https://opencollective.com/wechaty/backer/badge.svg?label=open%20collective%20backers&color=blue)](https://opencollective.com/wechaty/)
[![Open Collective Sponsors](https://opencollective.com/wechaty/sponsors/badge.svg?label=open%20collective%20sponsors&color=blue)](https://opencollective.com/wechaty/)

[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty/images/0)](https://sourcerer.io/fame/huan/wechaty/wechaty/links/0)
[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty/images/1)](https://sourcerer.io/fame/huan/wechaty/wechaty/links/1)
[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty/images/2)](https://sourcerer.io/fame/huan/wechaty/wechaty/links/2)
[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty/images/3)](https://sourcerer.io/fame/huan/wechaty/wechaty/links/3)
[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty/images/4)](https://sourcerer.io/fame/huan/wechaty/wechaty/links/4)
[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty/images/5)](https://sourcerer.io/fame/huan/wechaty/wechaty/links/5)
[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty/images/6)](https://sourcerer.io/fame/huan/wechaty/wechaty/links/6)
[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty/images/7)](https://sourcerer.io/fame/huan/wechaty/wechaty/links/7)

This project exists thanks to all the people who contribute.

---

[![Contribute](https://opencollective.com/wechaty/contributors.svg?width=890&button=false)](https://github.com/Wechaty/wechaty/graphs/contributors)

### Backers

[![Backers on Open Collective](https://opencollective.com/wechaty/backers/badge.svg)](#backers)

Thank you to all our backers! 🙏. [[Become a backer](https://opencollective.com/wechaty#backer)]

[![Open Collective Wechaty](https://opencollective.com/wechaty/backers.svg?width=890)](https://opencollective.com/wechaty#backers)

### Sponsors

[![Sponsors on Open Collective](https://opencollective.com/wechaty/sponsors/badge.svg)](#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)]

[![Wechaty Sponsor](https://opencollective.com/wechaty/sponsor.svg?width=890)](https://opencollective.com/wechaty/#sponsor)

## Join us

Scan the following QRCode and reply with "wechaty" to join the home of Wechaty Developers.

![Wechaty Developers' Home](../static/img/friday-qrcode.svg)