docs: update readme

This commit is contained in:
molvqingtai 2024-09-27 15:32:20 +08:00
parent a447f7bf01
commit faad87ceac
3 changed files with 6461 additions and 8206 deletions

View file

@ -1,6 +1,32 @@
# [WIP] WebChat
> Chatting Anonymously with People on the Same Website.
# WebChat
> Chat with anyone on any website
This is an anonymous chat browser extension that is decentralized and serverless, utilizing WebRTC for end-to-end encrypted communication. It prioritizes privacy, with all data stored locally. The goal is to address the issue of delayed replies on websites by adding instant messaging capabilities to any site, allowing for chatting anytime, anywhere.
### Standing on the Shoulders of Giants
In addition to the great idea of decentralized chat, it also leverages some fantastic technologies.
* **[remesh](https://github.com/remesh-js/remesh)**: A frontend framework that implements DDD principles in code, achieving true separation of UI and logic. This provides a robust structure that can be easily migrated to other frontend frameworks like Vue.
* **[shadcn/ui](https://ui.shadcn.com/)**: A beautiful UI library and a pioneer of no-install options, with unmatched ease of customizing styles.
* **[wxt](https://wxt.dev/)**: This is the best framework Ive used for building browser extensions, bar none.
* **[trystero](https://github.com/dmotz/trystero)**: The core dependency for implementing decentralized communication, enabling connections to decentralized networks like IPFS, torrent, Nostr, etc.
### License

View file

@ -2,7 +2,7 @@
"name": "web-chat",
"displayName": "WebChat",
"version": "0.0.1",
"description": "Chatting Anonymously with People on the Same Website.",
"description": "Chat with anyone on any website.",
"type": "module",
"scripts": {
"dev": "wxt",

File diff suppressed because it is too large Load diff