diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6634af8..c118597 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,10 +18,6 @@ These instructions run the App in Fast Refresh mode so you can make changes and > Note: If you have trouble running `kepler build` try sourcing the environment first! > `source ~/.kepler/kntools/environment-setup-sdk.sh` -> Note: Right now the system is set to load the plugin from the tarball file in the root. If you make changes in the library itself you will have to `npm pack` to make sure it reloads everything! - -Future Work: package redirects just like in the core monorepo - ## Working on the Library The library itself is plain TS code. As such you can use any normal NPM commands. diff --git a/README.md b/README.md index 11f16d3..55bbad3 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,11 @@ This plugin contains support for Amazon Vega as a platform for React Native apps Install the dependencies for this package: -`npm install react-native-uuid @amzn/react-native-device-info @segment/analytics-react-native@beta` +`npm install react-native-uuid @amazon-devices/react-native-device-info @segment/analytics-react-native@beta` -Then install this package from tarball (Pending Public Release): +Then install this package from npm registry -`npm install segment-analytics-react-native-plugin-kepler-0.1.0.tgz` +`npm install @segment/analytics-react-native-plugin-kepler` Now create you client as follows: @@ -30,7 +30,7 @@ See the [main readme](https://github.com/segmentio/analytics-react-native/blob/c ## Limitations -- `@amzn/react-native-device-info` does not currently support accessing all the device information such as app name and version, screen dimensions, OS versions, locale, etc. Some information inside the context will be set to `unknown` or empty values. These will come online as Amazon starts adding this information in future package releases. +- `@amazon-devices/react-native-device-info` does not currently support accessing all the device information such as app name and version, screen dimensions, OS versions, locale, etc. Some information inside the context will be set to `unknown` or empty values. These will come online as Amazon starts adding this information in future package releases. - `trackDeepLinks` option is not supported. - `Native AnonymousId` is not supported diff --git a/RELEASE.md b/RELEASE.md index 0b94ab7..7ecd260 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -6,5 +6,5 @@ To create a manual relase: 1. Update the version number of the package by running `npm version --patch` or manually in `package.json` 2. `npm run build` -3. Run `npm pack` -4. Share the tarball file +3. Run `npm publish --dry-run` to make sure everything is cool +4. and then `npm publish` diff --git a/analytics-react-native-plugin-kepler.code-workspace b/analytics-react-native-plugin-kepler.code-workspace deleted file mode 100644 index 645e5c8..0000000 --- a/analytics-react-native-plugin-kepler.code-workspace +++ /dev/null @@ -1,11 +0,0 @@ -{ - "folders": [ - { - "path": "." - }, - { - "path": "example" - } - ], - "settings": {} -} \ No newline at end of file