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

docs: add readme file with notes on how our NPM packaging works #26

Merged
merged 2 commits into from
May 9, 2023

Conversation

michaelx11
Copy link
Contributor

Overview

Provides a breakdown of how our RN SDK is packaged, how it references the iOS/Android SDKs and how consuming projects use it.

Not too much else to write in the description, most of the writing is in package_notes.md themselves.

@michaelx11 michaelx11 requested a review from jhaaaa as a code owner May 2, 2023 21:03
@michaelx11 michaelx11 requested review from nakajima and nplasterer May 2, 2023 21:03
Copy link
Contributor

@nplasterer nplasterer left a comment

Choose a reason for hiding this comment

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

It looks good to me! Thanks for adding this.

These files (build.gradle, XMTPReactNative.podspec) reference the XMTP Android and iOS SDKs respectively:
```
# Android
implementation "org.xmtp:android:0.1.1"
Copy link
Contributor

Choose a reason for hiding this comment

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

I believe we are pointing at org.xmtp:android:0.1.3

@michaelx11 michaelx11 merged commit 1a5101a into main May 9, 2023
@michaelx11 michaelx11 deleted the michaelx-packaging_notes_clean branch May 9, 2023 20:33
@github-actions
Copy link
Contributor

🎉 This PR is included in version 1.0.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants