Skip to content

readme upd #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jackmuva merged 1 commit into from
Jul 23, 2026
Merged

readme upd #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,24 +101,25 @@ Place the module where Expo autolinking looks — a `modules/` folder at your pr
cp -R modules/plaud-sdk /path/to/your-app/modules/plaud-sdk
```

Then reference it from your app's `package.json` so Metro and TypeScript resolve the
`plaud-sdk` import to the local folder:
The module's `expo-module.config.json` is what makes autolinking pick it up, so Metro and the
native build resolve the `plaud-sdk` import automatically.

The one thing to add is a TypeScript path mapping so
the `import { PlaudSdk } from 'plaud-sdk'` type-resolves. In your app's `tsconfig.json`:

```jsonc
// your-app/package.json
// your-app/tsconfig.json
{
"dependencies": {
"plaud-sdk": "file:./modules/plaud-sdk"
"compilerOptions": {
"paths": {
"plaud-sdk": ["./modules/plaud-sdk"]
}
}
}
```

```bash
npm install
```

> The module's `expo-module.config.json` is what makes autolinking pick it up — no manual
> native linking, no Podfile edits.
> No `npm install` is needed for the module — it isn't an installed package. Autolinking
> discovers it from `modules/` at prebuild/build time.

### Step 2: declare BLE permissions in `app.json`

Expand Down
Loading