Skip to content

Commit 2008fa1

Browse files
authored
chore: update main readme (#2)
1 parent c876ddf commit 2008fa1

File tree

2 files changed

+32
-72
lines changed

2 files changed

+32
-72
lines changed

README.md

Lines changed: 27 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,41 @@
1-
# Turborepo starter
1+
# Formbricks React Native SDK
22

3-
This Turborepo starter is maintained by the Turborepo core team.
3+
[![npm package](https://img.shields.io/npm/v/@formbricks/react-native?style=flat-square)](https://www.npmjs.com/package/@formbricks/react-native)
4+
[![MIT License](https://img.shields.io/badge/License-MIT-red.svg?style=flat-square)](https://opensource.org/licenses/MIT)
45

5-
## Using this example
6+
Please see [Formbricks Docs](https://formbricks.com/docs).
7+
Specifically, [Framework Guides](https://formbricks.com/docs/xm-and-surveys/surveys/website-app-surveys/framework-guides).
68

7-
Run the following command:
9+
## What is Formbricks
810

9-
```sh
10-
npx create-turbo@latest
11-
```
12-
13-
## What's inside?
14-
15-
This Turborepo includes the following packages/apps:
16-
17-
### Apps and Packages
18-
19-
- `docs`: a [Next.js](https://nextjs.org/) app
20-
- `web`: another [Next.js](https://nextjs.org/) app
21-
- `@repo/ui`: a stub React component library shared by both `web` and `docs` applications
22-
- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
23-
- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo
24-
25-
Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
26-
27-
### Utilities
28-
29-
This Turborepo has some additional tools already setup for you:
30-
31-
- [TypeScript](https://www.typescriptlang.org/) for static type checking
32-
- [ESLint](https://eslint.org/) for code linting
33-
- [Prettier](https://prettier.io) for code formatting
34-
35-
### Build
36-
37-
To build all apps and packages, run the following command:
38-
39-
```
40-
cd my-turborepo
41-
pnpm build
42-
```
43-
44-
### Develop
45-
46-
To develop all apps and packages, run the following command:
47-
48-
```
49-
cd my-turborepo
50-
pnpm dev
51-
```
52-
53-
### Remote Caching
54-
55-
> [!TIP]
56-
> 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).
11+
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).
5712

58-
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.
13+
## How to use this library
5914

60-
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:
15+
1. Install the Formbricks package inside your project using npm:
6116

62-
```
63-
cd my-turborepo
64-
npx turbo login
17+
```bash
18+
npm install @formbricks/react-native
6519
```
6620

67-
This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
21+
1. Import Formbricks and initialize the widget in your main component (e.g., App.tsx or App.js):
6822

69-
Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:
23+
```javascript
24+
import Formbricks, { track } from "@formbricks/react-native";
7025

26+
export default function App() {
27+
return (
28+
<View>
29+
{/* Your app code */}
30+
<Formbricks
31+
appUrl="https://app.formbricks.com"
32+
environmentId="your-environment-id"
33+
/>
34+
</View>
35+
);
36+
}
7137
```
72-
npx turbo link
73-
```
74-
75-
## Useful Links
7638

77-
Learn more about the power of Turborepo:
39+
Replace your-environment-id with your actual environment ID. You can find your environment ID in the **Connections instructions** in the Formbricks **Configuration** pages.
7840

79-
- [Tasks](https://turborepo.com/docs/core-concepts/monorepos/running-tasks)
80-
- [Caching](https://turborepo.com/docs/core-concepts/caching)
81-
- [Remote Caching](https://turborepo.com/docs/core-concepts/remote-caching)
82-
- [Filtering](https://turborepo.com/docs/core-concepts/monorepos/filtering)
83-
- [Configuration Options](https://turborepo.com/docs/reference/configuration)
84-
- [CLI Usage](https://turborepo.com/docs/reference/command-line-reference)
41+
For more detailed guides for different frameworks, check out our [Framework Guides](https://formbricks.com/docs/getting-started/framework-guides).

packages/react-native/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![MIT License](https://img.shields.io/badge/License-MIT-red.svg?style=flat-square)](https://opensource.org/licenses/MIT)
55

66
Please see [Formbricks Docs](https://formbricks.com/docs).
7-
Specifically, [Framework Guides](https://formbricks.com/docs/getting-started/framework-guides).
7+
Specifically, [Framework Guides](https://formbricks.com/docs/xm-and-surveys/surveys/website-app-surveys/framework-guides).
88

99
## What is Formbricks
1010

@@ -27,7 +27,10 @@ export default function App() {
2727
return (
2828
<View>
2929
{/* Your app code */}
30-
<Formbricks appUrl="https://app.formbricks.com" environmentId="your-environment-id" />
30+
<Formbricks
31+
appUrl="https://app.formbricks.com"
32+
environmentId="your-environment-id"
33+
/>
3134
</View>
3235
);
3336
}

0 commit comments

Comments
 (0)