Skip to content

Commit ef550eb

Browse files
committed
chore(docs): updated readme
1 parent 9276834 commit ef550eb

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

README.md

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

1515
## Features
1616

17+
This module includes a range of features designed to streamline broadcasting:
18+
1719
- Sanctum-based authentication
18-
- CSRF cookie management for Private and Presence channels
19-
- CSR-only mode
20+
- CSRF cookie and token management for Private and Presence channels
21+
- CSR-only mode (plugin is not loaded in SSR)
2022
- TypeScript support
23+
- Simple configuration
24+
- Request interceptors, token storage, composables and more...
2125

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.
26+
**Note:** Before using this module, make sure you have a [Laravel Echo](https://laravel.com/docs/12.x/broadcasting) server running and properly configured.
2327

2428
## Quick Setup
2529

@@ -33,15 +37,15 @@ Then provide the configuration in your `nuxt.config.js`:
3337

3438
```typescript
3539
export default defineNuxtConfig({
36-
modules: ['nuxt-laravel-echo'],
40+
modules: ["nuxt-laravel-echo"],
3741

3842
echo: {
39-
key: 'REPLACE_ME', // Your Laravel Echo app key
43+
key: "REPLACE_ME", // Your Laravel Echo app key
4044
authentication: {
41-
baseUrl: 'laravel.test', // Your Laravel app URL
45+
baseUrl: "laravel.test", // Your Laravel app URL
4246
},
4347
},
44-
})
48+
});
4549
```
4650

4751
Also, to enable Dev server compatibility with Pusher, you need to add the following Vite configuration to your `nuxt.config.js`:
@@ -50,10 +54,10 @@ Also, to enable Dev server compatibility with Pusher, you need to add the follow
5054
export default defineNuxtConfig({
5155
vite: {
5256
optimizeDeps: {
53-
include: ['pusher-js'],
57+
include: ["nuxt-laravel-echo > pusher-js"],
5458
},
5559
},
56-
})
60+
});
5761
```
5862

5963
That's it! You can now use Nuxt Laravel Echo in your Nuxt app ✨
@@ -67,12 +71,12 @@ If you want to contribute to this project and make it better, your help is very
6771
[npm-version-src]: https://img.shields.io/npm/v/nuxt-laravel-echo/latest.svg?style=flat&colorA=020420&colorB=00DC82
6872
[npm-version-href]: https://npmjs.com/package/nuxt-laravel-echo
6973
[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-laravel-echo.svg?style=flat&colorA=020420&colorB=00DC82
70-
[npm-downloads-href]: https://npmjs.com/package/nuxt-laravel-echo
74+
[npm-downloads-href]: https://npm.chart.dev/nuxt-laravel-echo
7175
[license-src]: https://img.shields.io/npm/l/nuxt-laravel-echo.svg?style=flat&colorA=020420&colorB=00DC82
7276
[license-href]: https://npmjs.com/package/nuxt-laravel-echo
7377
[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
7478
[nuxt-href]: https://nuxt.com
7579

7680
### Powered by
77-
[![JetBrains logo.](https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg)](https://jb.gg/OpenSource)
7881

82+
[![JetBrains logo.](https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg)](https://jb.gg/OpenSource)

0 commit comments

Comments
 (0)