Skip to content

Commit

Permalink
Updated example 2
Browse files Browse the repository at this point in the history
  • Loading branch information
burkmarr committed Nov 12, 2024
1 parent 7044177 commit f2feed1
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,19 @@ or include them in code directly from a CDN, e.g:
## API documentation and code examples
For details of the API, view the [JSDoc API documentation](https://biologicalrecordscentre.github.io/brc-atlas-bigr/api/).

There are also a number of [working examples](https://biologicalrecordscentre.github.io/brc-atlas-bigr/).
There are also a number of [working examples](https://biologicalrecordscentre.github.io/brc-atlas-bigr/).

## Notes for developers
### Typical update workflow
- npm run prepare
- npm run lint
- npm test
- npm run build
- npm run docs
- npm login (if publishing to Node)
- npm publish (if publishing to Node)
- git commit
- git push

Because this is a published Node package the CDN https://unpkg.com/brc-atlas-bigr@version/dist/bigr.min.umd.js is automatically maintained with 'version' being replaced by the npm package version number when published.

4 changes: 2 additions & 2 deletions docs/example-2.html
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,8 @@ <h2>Using the British Isles Grid Reference (bigr) library</h2>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>

<!-- <script src="https://unpkg.com/brc-atlas-bigr/dist/bigr.min.umd.js"></script> -->
<script src="../dist/bigr.min.umd.js"></script>
<script src="https://unpkg.com/brc-atlas-bigr/dist/bigr.min.umd.js"></script>
<!-- <script src="../dist/bigr.min.umd.js"></script> -->
<script src="https://unpkg.com/[email protected]/dist/leaflet.js"></script>
<link rel="stylesheet" href="https://unpkg.com/[email protected]/dist/leaflet.css" />
<script src="https://d3js.org/d3.v5.min.js"></script>
Expand Down

0 comments on commit f2feed1

Please sign in to comment.