Merge pull request #19 from xmtp/updt-readme

Docs: Update repo readme and link content type READMEs to their related XIPs
xmtp · Jul 20, 2023 · 7e4f76d · 7e4f76d
2 parents f171970 + 4ecabad
commit 7e4f76d
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -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
 

diff --git a/packages/content-type-reaction/README.md b/packages/content-type-reaction/README.md
@@ -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).
+
 ## 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.

diff --git a/packages/content-type-remote-attachment/README.md b/packages/content-type-remote-attachment/README.md
@@ -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:

diff --git a/packages/content-type-reply/README.md b/packages/content-type-reply/README.md
@@ -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).
+
 ## 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.