Skip to content

Commit

Permalink
Clean up and addd updated contribution section
Browse files Browse the repository at this point in the history
  • Loading branch information
mikalai-snap committed Mar 22, 2024
1 parent de88058 commit 976501e
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 25 deletions.
3 changes: 3 additions & 0 deletions .yarnrc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,6 @@ plugins:
spec: "@yarnpkg/plugin-version"

yarnPath: .yarn/releases/yarn-3.6.1.cjs

npmPublishRegistry: https://registry.npmjs.org/
npmRegistryServer: https://registry.npmjs.org/
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Camera Kit wrapper for React Native

This project provides a wrapper to Snap's [Camera Kit](https://ar.snap.com/camera-kit) solution that simplifies and speeds up the integration process for developers building React Native apps. While development on native platforms is still a recommended way, this wrapper provides a convenient way to implement basic functionalities of Camera Kit in React Native application.
This project provides a wrapper to Snap's [Camera Kit](https://ar.snap.com/camera-kit) solution that simplifies and speeds up the integration process for developers building React Native apps. While development on native platforms is still a recommended way, this wrapper provides a convenient way to implement basic functionalities of Camera Kit in React Native application.

>**Note:** Advanced functionalities like Remote API support, Inclusive Camera features, etc. are not supported in this wrapper implementation yet. If your project needs the missing features then feel free to implement it yourself and submit a PR to this repo or use native development environment.
Expand Down Expand Up @@ -47,7 +47,7 @@ export function App() {
useEffect(async () => {
setPosition("front");
})

return (
<CameraKitContext apiToken="<API Token from Camera Kit Portal>" safeArea={{top: 100, bottom: 200}}>
<PreviewView />
Expand Down Expand Up @@ -102,7 +102,16 @@ function Lenses({ groupId }: { groupId: string }) {
```

## Contributing
If you would like to contribute to this repo, please feel free to open a pull request. Make sure you test your changes with the [example](./example) project and update the required [docs](./docs) section by running `yarn docs` command. We are always looking for ways to improve the Camera Kit offering. Thank you for your contribution!! :pray:
Thank you for your interest in improving our project! :pray:

Here's how you can contribute:

1. Fork and clone this repository.
2. Install dependencies by running `yarn install --immutable && yarn prepare`.
3. Make your changes.
4. Test your changes with the example app using `yarn example start`. Ensure everything works as expected.
5. Update the documentation if necessary by running `yarn docs`.
6. Submit a pull request with a clear description of your changes.

## License
Please refer to the [LICENSE](/LICENSE) file for license information.
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@
"lint": "eslint \"**/*.{js,ts,tsx}\" && prettier -l \"**/*.{js,ts,tsx}\"",
"clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib docs",
"prepare": "bob build",
"pack:machamp": "./scripts/pack.sh",
"docs": "npx typedoc src/index.tsx --tsconfig tsconfig.json"
},
"keywords": [
Expand Down
21 changes: 0 additions & 21 deletions scripts/pack.sh

This file was deleted.

0 comments on commit 976501e

Please sign in to comment.