Skip to content

Commit c431fae

Browse files
feat: updated relevant documents
1 parent 71c509a commit c431fae

File tree

4 files changed

+6
-21
lines changed

4 files changed

+6
-21
lines changed

CONTRIBUTING.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,6 @@ These instructions run the App in Fast Refresh mode so you can make changes and
1818
> Note: If you have trouble running `kepler build` try sourcing the environment first!
1919
> `source ~/.kepler/kntools/environment-setup-sdk.sh`
2020
21-
> 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!
22-
23-
Future Work: package redirects just like in the core monorepo
24-
2521
## Working on the Library
2622

2723
The library itself is plain TS code. As such you can use any normal NPM commands.

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ This plugin contains support for Amazon Vega as a platform for React Native apps
66

77
Install the dependencies for this package:
88

9-
`npm install react-native-uuid @amzn/react-native-device-info @segment/analytics-react-native@beta`
9+
`npm install react-native-uuid @amazon-devices/react-native-device-info @segment/analytics-react-native@beta`
1010

11-
Then install this package from tarball (Pending Public Release):
11+
Then install this package from npm registry
1212

13-
`npm install segment-analytics-react-native-plugin-kepler-0.1.0.tgz`
13+
`npm install @segment/analytics-react-native-plugin-kepler`
1414

1515
Now create you client as follows:
1616

@@ -30,7 +30,7 @@ See the [main readme](https://github.com/segmentio/analytics-react-native/blob/c
3030

3131
## Limitations
3232

33-
- `@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.
33+
- `@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.
3434
- `trackDeepLinks` option is not supported.
3535
- `Native AnonymousId` is not supported
3636

RELEASE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ To create a manual relase:
66

77
1. Update the version number of the package by running `npm version --patch` or manually in `package.json`
88
2. `npm run build`
9-
3. Run `npm pack`
10-
4. Share the tarball file
9+
3. Run `npm publish --dry-run` to make sure everything is cool
10+
4. and then `npm publish`

analytics-react-native-plugin-kepler.code-workspace

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)