Skip to content
This repository has been archived by the owner on Oct 10, 2024. It is now read-only.

Docs: Update repo readme and link content type READMEs to their related XIPs #19

Merged
merged 1 commit into from
Jul 20, 2023
Merged

Docs: Update repo readme and link content type READMEs to their related XIPs #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ To learn more about the contents of this repository, see this README and the REA

### Packages

- [`content-type-remote-attachment`](packages/content-type-remote-attachment): This package provides a remote attachment content type.
- [`content-type-remote-attachment`](packages/content-type-remote-attachment)
- [`content-type-reaction`](packages/content-type-reaction)
- [`content-type-reply`](packages/content-type-reply)

## Requirements

Expand Down
3 changes: 3 additions & 0 deletions packages/content-type-reaction/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

This package provides an XMTP content type to support reactions to messages.

> **Open for feedback**
> You are welcome to provide feedback on this implementation by commenting on the [Reaction Content Type XIP](https://github.com/xmtp/XIPs/pull/23) (XMTP Improvement Proposal).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same for reactions https://github.com/orgs/xmtp/discussions/36


## What’s a reaction?

A reaction is a quick and often emoji-based way to respond to a message. Reactions are usually limited to a predefined set of emojis or symbols provided by the messaging app.
Expand Down
3 changes: 3 additions & 0 deletions packages/content-type-remote-attachment/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

The [remote-attachment](https://github.com/xmtp/xmtp-js-content-types/tree/main/remote-attachment) package provides an XMTP content type to support sending file attachments that are stored off-network. Use it to enable your app to send and receive message attachments.

> **Open for feedback**
> You are welcome to provide feedback on this implementation by commenting on the [Remote Attachment Content Type XIP](https://github.com/xmtp/XIPs/blob/main/XIPs/xip-17-remote-attachment-content-type-proposal.md) (XMTP Improvement Proposal).

## What’s an attachment?

Attachments are files. More specifically, attachments are objects that have:
Expand Down
3 changes: 3 additions & 0 deletions packages/content-type-reply/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

This package provides an XMTP content type to support direct replies to messages.

> **Open for feedback**
> You are welcome to provide feedback on this implementation by commenting on the [Reply Content Type XIP](https://github.com/xmtp/XIPs/pull/22) (XMTP Improvement Proposal).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we are actually encouraging people to comment in the discussion and not the XIP. https://github.com/orgs/xmtp/discussions/35


## What’s a reply?

A reply action is a way to respond directly to a specific message in a conversation. Instead of sending a new message, users can select and reply to a particular message.
Expand Down