Skip to content

Commit

Permalink
Version 4.1.0: add the js iife bundle as a static file
Browse files Browse the repository at this point in the history
  • Loading branch information
synw committed Dec 10, 2022
1 parent c14f320 commit f627705
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 2 deletions.
3 changes: 2 additions & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
recursive-include instant/migrations *
recursive-include instant/management *
recursive-include instant/management *
recursive-include instant/static *
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,20 @@ Several options are available for the client side
Manage your websockets connection manually with the official Centrifugo js library:
[Centrifuge-js](https://github.com/centrifugal/centrifuge-js)

### Use the embeded client in a script tag

In a Django template:

```html
{% load static %}
<script src="{% static 'instant/index.min.js' %}"></script>
<script>
const instant = $instant.useInstant();
</script>
```

[Api doc](https://github.com/synw/djangoinstant#usage)

### Use the npm client

A dedicated [client](https://github.com/synw/djangoinstant) is available from npm
Expand Down
2 changes: 1 addition & 1 deletion instant/__init__.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
__version__ = "4.0.1"
__version__ = "4.1.0"
default_app_config = "instant.apps.InstantConfig"
1 change: 1 addition & 0 deletions instant/static/instant/index.min.js

Large diffs are not rendered by default.

0 comments on commit f627705

Please sign in to comment.