Add individual CHANGELOGs and update README.md

magiclabs · smithki · Jun 4, 2020 · May 24, 2020 · May 24, 2020 · May 24, 2020
commit 47065fd2e33570b7db8a4dbf236e791dd537f9ee
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -33,7 +33,7 @@ Please note we have a **code of conduct**, please follow it in all your interact
 
 ## Opening a Pull Request
 
-1. Update the **`Upcoming Changes`** section of [`CHANGELOG.md`](./CHANGELOG.md) with your fixes, changes, or additions. A maintainer will label your changes with a version number and release date once they are published.
+1. Update the **`Upcoming Changes`** section of the relevante package's `CHANGELOG.md` with your fixes, changes, or additions. A maintainer will label your changes with a version number and release date once they are published.
 2. Open a pull request from your fork/branch to the upstream `master` branch of _this_ repository.
 3. A maintainer will review your code changes and offer feedback or suggestions if necessary. Once your changes are approved, a maintainer will merge the pull request for you and publish a release.
 

diff --git a/README.md b/README.md
@@ -6,24 +6,34 @@
 
 <p align="center">
   <a href="./LICENSE">License</a> ·
-  <a href="./CHANGELOG.md">Changelog</a> ·
   <a href="./CONTRIBUTING.md">Contributing Guide</a>
 </p>
 
 ## 📖 Documentation
 
 See the [developer documentation](https://docs.magic.link) to learn how you can master the Magic SDK in a matter of minutes.
 
+## 📦 Package Ecosystem
+
+| Package directory | Package Name | Changelog | Description |
+| ----------------- | ------------ | ------- | ----------- |
+| [`/web`](./packages/web) | [`magic-sdk`](https://www.npmjs.com/package/magic-sdk) | [CHANGELOG](./packages/web/CHANGELOG.md) | Web/browser entry-point for Magic SDK. |
+| [`/react-native`](./packages/react-native) | [`@magic-sdk/react-native`](https://www.npmjs.com/package/@magic-sdk/react-native) | [CHANGELOG](./packages/react-native/CHANGELOG.md) | React Native entry-point for Magic SDK. |
+| [`/types`](./packages/types) | [`@magic-sdk/types`](https://www.npmjs.com/package/@magic-sdk/types) | [CHANGELOG](./packages/types/CHANGELOG.md) | Core typings shared between JavaScript entry-points of Magic SDK. |
+| [`/provider`](./packages/provider) | [`@magic-sdk/provider`](https://www.npmjs.com/package/@magic-sdk/provider) | [CHANGELOG](./packages/provider/CHANGELOG.md) | Core business logic shared between JavaScript entry-points of Magic SDK. |
+
 ## 🔗 Installation
 
 Integrating your app with Magic will require our client-side NPM package:
 
 ```bash
 # Via NPM:
-npm install --save magic-sdk
+npm install --save magic-sdk # If you're targeting web browsers
+npm install --save @magic-sdk/react-native # If you're targeting React Native
 
 # Via Yarn:
-yarn add magic-sdk
+yarn add magic-sdk # If you're targeting web browsers
+yarn add @magic-sdk/react-native # If you're targeting React Native
 ```
 
 Alternatively, you can load via CDN with by adding a script tag to your app’s `<head>`:

diff --git a/packages/provider/CHANGELOG.md b/packages/provider/CHANGELOG.md
@@ -0,0 +1,29 @@
+## Upcoming Changes
+
+#### Fixed
+
+- Circle CI tag in readme is broken after namechange from MagicHQ to MagicLabs
+
+#### Changed
+
+- ...
+
+#### Added
+
+- ...
+
+## `1.0.0` - 06/02/2020
+
+This is the first release our changelog records. Future updates will be logged in the following format:
+
+#### Fixed
+
+- Bug fixes and patches will be described here.
+
+#### Changed
+
+- Changes (breaking or otherwise) to current APIs will be described here.
+
+#### Added
+
+- New features or APIs will be described here.
diff --git a/packages/react-native/CHANGELOG.md b/packages/react-native/CHANGELOG.md
@@ -0,0 +1,29 @@
+## Upcoming Changes
+
+#### Fixed
+
+- Circle CI tag in readme is broken after namechange from MagicHQ to MagicLabs
+
+#### Changed
+
+- ...
+
+#### Added
+
+- ...
+
+## `1.0.0` - 06/02/2020
+
+This is the first release our changelog records. Future updates will be logged in the following format:
+
+#### Fixed
+
+- Bug fixes and patches will be described here.
+
+#### Changed
+
+- Changes (breaking or otherwise) to current APIs will be described here.
+
+#### Added
+
+- New features or APIs will be described here.
diff --git a/packages/types/CHANGELOG.md b/packages/types/CHANGELOG.md
@@ -0,0 +1,29 @@
+## Upcoming Changes
+
+#### Fixed
+
+- Circle CI tag in readme is broken after namechange from MagicHQ to MagicLabs
+
+#### Changed
+
+- ...
+
+#### Added
+
+- ...
+
+## `1.0.0` - 06/02/2020
+
+This is the first release our changelog records. Future updates will be logged in the following format:
+
+#### Fixed
+
+- Bug fixes and patches will be described here.
+
+#### Changed
+
+- Changes (breaking or otherwise) to current APIs will be described here.
+
+#### Added
+
+- New features or APIs will be described here.
diff --git a/CHANGELOG.md → packages/web/CHANGELOG.md b/CHANGELOG.md → packages/web/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 #### Fixed
 
-- Circle CI tag in readme is broken after namechange from MagicHQ to MagicLabs
+- ...
 
 #### Changed
 
@@ -12,6 +12,16 @@
 
 - ...
 
+## `2.0.0` - 06/02/2020
+
+#### Fixed
+
+- Circle CI tag in readme is broken after namechange from MagicHQ to MagicLabs
+
+#### Changed
+
+- Removed the `magic-sdk/react-native` entry-point. To use React Native with Magic SDK, install `@magic-sdk/react-native` instead. There are no breaking API changes related to public SDK methods.
+
 ## `1.4.0` - 05/14/2020
 
 #### Added