Skip to content

Improve unpkg and jsDelivr support #343

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 4, 2018
Merged

Improve unpkg and jsDelivr support #343

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d964cc8
Use non-minified file for unpkg
lutovich Apr 4, 2018
3d6da21
Specify browser build to be used by jsdelivr
lutovich Apr 4, 2018
4234253
Update README with CDN links
lutovich Apr 4, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,22 @@ otherwise application shutdown might hang or it might exit with a non-zero exit
## Include in web browser

We build a special browser version of the driver, which supports connecting to Neo4j over WebSockets.
It can be included in an HTML page using one of the following tags:

```html
<!-- Direct reference -->
<script src="lib/browser/neo4j-web.min.js"></script>

<!-- unpkg CDN non-minified -->
<script src="https://unpkg.com/neo4j-driver"></script>
<!-- unpkg CDN minified for production use, version X.Y.Z -->
<script src="https://unpkg.com/[email protected]/lib/browser/neo4j-web.min.js"></script>

<!-- jsDelivr CDN non-minified -->
<script src="https://cdn.jsdelivr.net/npm/neo4j-driver"></script>
<!-- jsDelivr CDN minified for production use, version X.Y.Z -->
<script src="https://cdn.jsdelivr.net/npm/[email protected]/lib/browser/neo4j-web.min.js"></script>

```

This will make a global `neo4j` object available, where you can access the `v1` API at `neo4j.v1`:
Expand Down
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@
"browser": "gulp browser && gulp test-browser"
},
"main": "lib/index.js",
"unpkg": "lib/browser/neo4j-web.min.js",
"unpkg": "lib/browser/neo4j-web.js",
"jsdelivr": "lib/browser/neo4j-web.js",
"types": "types/index.d.ts",
"devDependencies": {
"async": "^2.4.0",
Expand Down