Skip to content

Commit

Permalink
release: 4.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
sebtiz13 committed Aug 1, 2023
1 parent b1516c7 commit 9f81742
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 4 deletions.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Aside from the `backends` option, you can define the backend to connect to entir
* `VUE_APP_BACKEND_HOST` contains the hostname (e.g. `kuzzle.mydomain.com`),
* `VUE_APP_BACKEND_PORT` contains the port (e.g. `443`),
* `VUE_APP_BACKEND_SSL` can be set to `true` if the connection supports the SSL layer (do not set this variable if SSL is not supported).
* `VUE_APP_BACKEND_PROTO` can be set to either `http` or `websocket`. If left blank, Websocket protocol is used by default.
* `VUE_APP_BACKEND_PROTO` can be set to either `http` or `websocket`. If left blank, Websocket protocol is used by default.

For example, you can build your up to connect the Websocket to `wss://kuzzle.mydomain.com:443` like the following

Expand Down Expand Up @@ -113,3 +113,13 @@ And from anywhere in your app where the `Vue` class is available, as
```javascript
Vue.prototype.$kuzzle;
```

### Composition API (Vue 2.7 & 3)

In components with composition API you can use the composable to access the Kuzzle SDK instance

```javascript
import { useKuzzle } from 'vue-plugin-kuzzle';

const $kuzzle = useKuzzle();
```
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "vue-plugin-kuzzle",
"version": "4.4.0",
"version": "4.5.0",
"description": "A Vuejs plugin shipping the Kuzzle SDK in your components",
"main": "./dist/index.js",
"module": "./dist/index.js",
Expand Down

0 comments on commit 9f81742

Please sign in to comment.