Skip to content

Commit dfda46f

Browse files
Melih Gurgahclaude
andcommitted
docs: fix README code examples and links
- Remove invalid userId from config (passed to connect() instead) - Fix pollInterval default: 5000ms not 3000ms - Fix GitHub link to correct repo - Remove dead Discord link - Fix Contributing section with correct repo/commands Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 393530f commit dfda46f

File tree

2 files changed

+12
-19
lines changed

2 files changed

+12
-19
lines changed

README.md

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ const seenn = new Seenn({
4747
baseUrl: 'https://api.seenn.io', // Seenn Cloud
4848
// OR: 'https://api.yourapp.com' for self-hosted
4949
apiKey: 'pk_your_key',
50-
userId: 'user_123',
5150
debug: true, // Enable logging
5251
});
5352
```
@@ -107,7 +106,7 @@ Configure polling interval for your needs:
107106
const seenn = new Seenn({
108107
baseUrl: 'https://api.yourcompany.com',
109108
apiKey: 'pk_your_key', // or any token for self-hosted
110-
pollInterval: 5000, // Poll every 5 seconds (default: 3000)
109+
pollInterval: 3000, // Poll every 3 seconds (default: 5000)
111110
});
112111

113112
await seenn.connect(userId);
@@ -523,8 +522,7 @@ const seenn = new Seenn({
523522

524523
// Optional
525524
apiKey: 'pk_your_key', // API key (pk_* for Seenn Cloud)
526-
userId: 'user_123', // User ID for job filtering
527-
pollInterval: 3000, // Polling interval in ms (default: 3000)
525+
pollInterval: 5000, // Polling interval in ms (default: 5000)
528526
basePath: '/v1', // API base path (default: '/v1')
529527
debug: false, // Enable debug logging
530528
});
@@ -702,11 +700,10 @@ Yes! The SDK is open source (MIT). You can:
702700
703701
## Links
704702
705-
- 📖 [Documentation](https://docs.seenn.io)
706-
- 🌐 [Website](https://seenn.io)
707-
- 💬 [Discord](https://discord.gg/seenn)
708-
- 🐙 [GitHub](https://github.com/seenn-io/sdk)
709-
- 📦 [npm](https://www.npmjs.com/package/@seenn/react-native)
703+
- [Documentation](https://docs.seenn.io)
704+
- [Website](https://seenn.io)
705+
- [GitHub](https://github.com/seenn-io/react-native)
706+
- [npm](https://www.npmjs.com/package/@seenn/react-native)
710707
711708
---
712709
@@ -718,15 +715,11 @@ MIT © [Seenn](https://seenn.io)
718715
719716
## Contributing
720717
721-
Contributions welcome! See [CONTRIBUTING.md](https://github.com/seenn-io/sdk/blob/main/CONTRIBUTING.md)
718+
Contributions welcome!
722719
723720
```bash
724-
git clone https://github.com/seenn-io/sdk
725-
cd seenn-sdk
726-
pnpm install
727-
pnpm --filter @seenn/react-native dev
721+
git clone https://github.com/seenn-io/react-native
722+
cd react-native
723+
npm install
724+
npm run dev
728725
```
729-
730-
---
731-
732-
Made with ❤️ by [Seenn](https://seenn.io)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@seenn/react-native",
3-
"version": "0.9.5",
3+
"version": "0.9.6",
44
"description": "Seenn React Native SDK - Job state transport with iOS Live Activity support (Expo compatible)",
55
"main": "dist/index.js",
66
"module": "dist/index.mjs",

0 commit comments

Comments
 (0)