diff --git a/README.md b/README.md index b57eb76..4c3c448 100644 --- a/README.md +++ b/README.md @@ -1,84 +1,41 @@ -# Turborepo starter +# Formbricks React Native SDK -This Turborepo starter is maintained by the Turborepo core team. +[![npm package](https://img.shields.io/npm/v/@formbricks/react-native?style=flat-square)](https://www.npmjs.com/package/@formbricks/react-native) +[![MIT License](https://img.shields.io/badge/License-MIT-red.svg?style=flat-square)](https://opensource.org/licenses/MIT) -## Using this example +Please see [Formbricks Docs](https://formbricks.com/docs). +Specifically, [Framework Guides](https://formbricks.com/docs/xm-and-surveys/surveys/website-app-surveys/framework-guides). -Run the following command: +## What is Formbricks -```sh -npx create-turbo@latest -``` - -## What's inside? - -This Turborepo includes the following packages/apps: - -### Apps and Packages - -- `docs`: a [Next.js](https://nextjs.org/) app -- `web`: another [Next.js](https://nextjs.org/) app -- `@repo/ui`: a stub React component library shared by both `web` and `docs` applications -- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`) -- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo - -Each package/app is 100% [TypeScript](https://www.typescriptlang.org/). - -### Utilities - -This Turborepo has some additional tools already setup for you: - -- [TypeScript](https://www.typescriptlang.org/) for static type checking -- [ESLint](https://eslint.org/) for code linting -- [Prettier](https://prettier.io) for code formatting - -### Build - -To build all apps and packages, run the following command: - -``` -cd my-turborepo -pnpm build -``` - -### Develop - -To develop all apps and packages, run the following command: - -``` -cd my-turborepo -pnpm dev -``` - -### Remote Caching - -> [!TIP] -> Vercel Remote Cache is free for all plans. Get started today at [vercel.com](https://vercel.com/signup?/signup?utm_source=remote-cache-sdk&utm_campaign=free_remote_cache). +Formbricks is your go-to solution for in-product micro-surveys that will supercharge your product experience! 🚀 For more information please check out [formbricks.com](https://formbricks.com). -Turborepo can use a technique known as [Remote Caching](https://turborepo.com/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines. +## How to use this library -By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup?utm_source=turborepo-examples), then enter the following commands: +1. Install the Formbricks package inside your project using npm: -``` -cd my-turborepo -npx turbo login +```bash +npm install @formbricks/react-native ``` -This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview). +1. Import Formbricks and initialize the widget in your main component (e.g., App.tsx or App.js): -Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo: +```javascript +import Formbricks, { track } from "@formbricks/react-native"; +export default function App() { + return ( + + {/* Your app code */} + + + ); +} ``` -npx turbo link -``` - -## Useful Links -Learn more about the power of Turborepo: +Replace your-environment-id with your actual environment ID. You can find your environment ID in the **Connections instructions** in the Formbricks **Configuration** pages. -- [Tasks](https://turborepo.com/docs/core-concepts/monorepos/running-tasks) -- [Caching](https://turborepo.com/docs/core-concepts/caching) -- [Remote Caching](https://turborepo.com/docs/core-concepts/remote-caching) -- [Filtering](https://turborepo.com/docs/core-concepts/monorepos/filtering) -- [Configuration Options](https://turborepo.com/docs/reference/configuration) -- [CLI Usage](https://turborepo.com/docs/reference/command-line-reference) +For more detailed guides for different frameworks, check out our [Framework Guides](https://formbricks.com/docs/getting-started/framework-guides). diff --git a/packages/react-native/README.md b/packages/react-native/README.md index 81f446f..4c3c448 100644 --- a/packages/react-native/README.md +++ b/packages/react-native/README.md @@ -4,7 +4,7 @@ [![MIT License](https://img.shields.io/badge/License-MIT-red.svg?style=flat-square)](https://opensource.org/licenses/MIT) Please see [Formbricks Docs](https://formbricks.com/docs). -Specifically, [Framework Guides](https://formbricks.com/docs/getting-started/framework-guides). +Specifically, [Framework Guides](https://formbricks.com/docs/xm-and-surveys/surveys/website-app-surveys/framework-guides). ## What is Formbricks @@ -27,7 +27,10 @@ export default function App() { return ( {/* Your app code */} - + ); }