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

fix readme #165

Merged
merged 7 commits into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,21 @@
# MessageKit
# XMTP AI

This is the official repository for [MessageKit](https://message-kit.org/). Powered by [XMTP](http://xmtp.org)
A set of tools for AI developers to build on top of [XMTP](https://xmtp.org)

## What's inside?

### Packages
### MessageKit

- [`message-kit`](/packages/message-kit): A kit for quickly building messaging apps
- [`create-message-kit`](/packages/create-message-kit): A CLI for creating new apps easily
- [`framekit`](/packages/framekit): A suite for backend frames
- ['xmtp](/packages/xmtp/): A secure agent sdk
- [`xmtp-client`](/packages/xmtp-client/): Client sided agent sdk
- [`docs`](/packages/docs): Documentation for MessageKit

## Contributing
### Plugins

See our [contribution guide](./CONTRIBUTING.md) to learn more about contributing to this project.
- [`framekit`](/packages/framekit): A suite for backend frames
- [`xmtp`](/packages/xmtp/): A node js wrapper for AI agents.
- [`xmtp-client`](/packages/xmtp-client/): A client plugin for interacting with hte backend.

### Open Frames
## Contributing

XMTP contributes to the development of the Open Frames [standard](https://www.openframes.xyz).
See our [contribution guide](./CONTRIBUTING.md) to learn more about contributing to this project.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "message-kit-monorepo",
"name": "xmtp-ai",
"version": "1.2.35",
"private": true,
"type": "module",
Expand Down
19 changes: 2 additions & 17 deletions packages/create-message-kit/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,3 @@
# create-message-kit
# MessageKit

Is a command-line interface tool designed to help developers create and manage their custom build configurations easily.

To install it run the following command:

```bash
bun create message-kit
```

```bash
npx create-message-kit@latest
```

```bash
yarn create message-kit
// use yarn create message-kit@latest in yarn > v2
```
See [MessageKit](https://message-kit.org/) quickstart
3 changes: 3 additions & 0 deletions packages/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# MessageKit

See [MessageKit](https://message-kit.org/) docs
2 changes: 1 addition & 1 deletion packages/docs/pages/plugins/xmtp.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Xmtp ai
# XMTP AI

AI is transforming consumer tech, with messaging becoming the main channel for interacting with agent services. This shift will scale message traffic astronomically, akin to the web’s rise in the 2000s. Just as Cloudflare secured web traffic, messaging will need robust encryption, threat protection, and scalable infrastructure to handle the surge and protect sensitive AI-driven interactions.

Expand Down
12 changes: 1 addition & 11 deletions packages/message-kit/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,3 @@
# MessageKit

```bash
bun install @xmtp/message-kit
```

```bash
npm install @xmtp/message-kit
```

```bash
yarn create @xmtp/message-kit
```
See [MessageKit](https://message-kit.org/) docs
3 changes: 3 additions & 0 deletions packages/xmtp-client/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# XMTP AI

See [XMTP AI](https://message-kit.org/plugins/xmtp) plugin
3 changes: 3 additions & 0 deletions packages/xmtp/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# XMTP AI

See [XMTP AI](https://message-kit.org/plugins/xmtp) plugin
30 changes: 15 additions & 15 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -7836,21 +7836,6 @@ __metadata:
languageName: node
linkType: hard

"message-kit-monorepo@workspace:.":
version: 0.0.0-use.local
resolution: "message-kit-monorepo@workspace:."
dependencies:
"@changesets/changelog-git": "npm:^0.2.0"
"@changesets/cli": "npm:^2.27.5"
prettier: "npm:^3.3.1"
prettier-plugin-packagejson: "npm:^2.5.0"
punycode: "npm:^2.3.1"
readline-sync: "npm:^1.4.10"
turbo: "npm:^1.13.4"
typescript: "npm:^5.4.5"
languageName: unknown
linkType: soft

"methods@npm:~1.1.2":
version: 1.1.2
resolution: "methods@npm:1.1.2"
Expand Down Expand Up @@ -12276,6 +12261,21 @@ __metadata:
languageName: node
linkType: hard

"xmtp-ai@workspace:.":
version: 0.0.0-use.local
resolution: "xmtp-ai@workspace:."
dependencies:
"@changesets/changelog-git": "npm:^0.2.0"
"@changesets/cli": "npm:^2.27.5"
prettier: "npm:^3.3.1"
prettier-plugin-packagejson: "npm:^2.5.0"
punycode: "npm:^2.3.1"
readline-sync: "npm:^1.4.10"
turbo: "npm:^1.13.4"
typescript: "npm:^5.4.5"
languageName: unknown
linkType: soft

"xmtp-client@workspace:*, xmtp-client@workspace:packages/xmtp-client":
version: 0.0.0-use.local
resolution: "xmtp-client@workspace:packages/xmtp-client"
Expand Down
Loading