diff --git a/CHANGELOG.md b/CHANGELOG.md index 5fd9036d..87d8e1f0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,4 +10,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added - Project initialization. -[Unreleased]: https://github.com/status-im/dappconnect-sdks/compare/x...HEAD +[Unreleased]: https://github.com/status-im/wakuconnect-chat-sdk/compare/x...HEAD diff --git a/README.md b/README.md index e1cc640c..6b59778f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ -# DappConnect Chat SDK +# Waku Connect Chat SDK +A ReactJS SDK to easily integrate a decentralized, end-to-end encrypted chat feature to your dApp. + +The Waku Connect Chat SDK enables several type of chats: + +- 1:1 Encrypted chats +- Private group chats +- Spam resistant public chats, powered by Status Communities (an admin needs to run a Status Desktop or Mobile app to moderate) + +It also enables user to create their identity by either: + +- Using their Web3 wallet, or, +- Generate an anonymous identity locally. + +## Documentation + +WIP. diff --git a/package.json b/package.json index 321377eb..1f666737 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "dappconnect-sdks", + "name": "@waku/chat-sdk-root", "packageManager": "yarn@3.1.0", "license": "MIT OR Apache-2.0", "scripts": { diff --git a/packages/react-chat-example/package.json b/packages/react-chat-example/package.json index 36cf5266..bf198984 100644 --- a/packages/react-chat-example/package.json +++ b/packages/react-chat-example/package.json @@ -2,7 +2,7 @@ "name": "@waku/react-chat-sdk-example", "main": "index.js", "version": "0.1.0", - "repository": "https://github.com/status-im/dappconnect-chat-sdk/", + "repository": "https://github.com/status-im/wakuconnect-chat-sdk/", "license": "MIT OR Apache-2.0", "packageManager": "yarn@3.0.1", "scripts": { diff --git a/packages/react-chat-example/src/index.html b/packages/react-chat-example/src/index.html index df61d712..8bc17f8e 100644 --- a/packages/react-chat-example/src/index.html +++ b/packages/react-chat-example/src/index.html @@ -4,7 +4,7 @@ - DAppconnect chat + Waku Connect Chat
diff --git a/packages/react-chat-example/src/index.tsx b/packages/react-chat-example/src/index.tsx index 142d1c9d..71d13474 100644 --- a/packages/react-chat-example/src/index.tsx +++ b/packages/react-chat-example/src/index.tsx @@ -1,8 +1,4 @@ -import { - DappConnectCommunityChat, - darkTheme, - lightTheme, -} from "@waku/react-chat-sdk"; +import { CommunityChat, darkTheme, lightTheme } from "@waku/react-chat-sdk"; import React, { useRef, useState } from "react"; import ReactDOM from "react-dom"; import styled from "styled-components"; @@ -77,7 +73,7 @@ function DragDiv() { }} /> - Promise; } -export function DappConnectCommunityChat({ +export function CommunityChat({ theme, config, fetchMetadata, communityKey, -}: DappConnectCommunityChatProps) { +}: CommunityChatProps) { const ref = useRef(null); return ( @@ -43,7 +43,7 @@ export function DappConnectCommunityChat({ - +