Skip to content

Commit 877e0a0

Browse files
committed
updated readme
1 parent 3ac4e28 commit 877e0a0

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,12 @@ Nuxt module for Laravel Echo integration to get a seamless experience with appli
1414

1515
## Features
1616

17-
<!-- Highlight some of the features your module provide here -->
17+
- Sanctum-based authentication
18+
- CSRF cookie management for Private and Presence channels
19+
- CSR-only mode
20+
- TypeScript support
1821

19-
-&nbsp;Foo
20-
- 🚠 &nbsp;Bar
21-
- 🌲 &nbsp;Baz
22+
**Note:** Before using this module, make sure you have a [Laravel Echo](https://laravel.com/docs/11.x/broadcasting) server running and properly configured.
2223

2324
## Quick Setup
2425

@@ -28,6 +29,21 @@ Install the module to your Nuxt application with one command:
2829
npx nuxi module add nuxt-laravel-echo
2930
```
3031

32+
Then provide the configuration in your `nuxt.config.js`:
33+
34+
```typescript
35+
export default defineNuxtConfig({
36+
modules: ['nuxt-laravel-echo'],
37+
38+
echo: {
39+
key: 'REPLACE_ME', // Your Laravel Echo app key
40+
authentication: {
41+
baseUrl: 'laravel.test', // Your Laravel app URL
42+
},
43+
},
44+
})
45+
```
46+
3147
That's it! You can now use Nuxt Laravel Echo in your Nuxt app ✨
3248

3349
## Contribution

0 commit comments

Comments
 (0)