From f2feed19123fac86f0ba008203716f09427ee793 Mon Sep 17 00:00:00 2001 From: Rich Burkmar Date: Tue, 12 Nov 2024 16:37:46 +0000 Subject: [PATCH] Updated example 2 --- README.md | 17 ++++++++++++++++- docs/example-2.html | 4 ++-- 2 files changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e4ced94..3a6a2fe 100644 --- a/README.md +++ b/README.md @@ -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/). \ No newline at end of file +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. + diff --git a/docs/example-2.html b/docs/example-2.html index 429021d..ce900a2 100644 --- a/docs/example-2.html +++ b/docs/example-2.html @@ -134,8 +134,8 @@

Using the British Isles Grid Reference (bigr) library

- - + +