fix(terra-draw-maplibre-gl-adapter): ensure the README has correct li…

…nks on npm (#419)

.github/workflows/terra-draw-maplibre-gl-adapter-release.yml

@@ -43,6 +43,18 @@ jobs:
         working-directory: ./packages/terra-draw-maplibre-gl-adapter
         run: npm run release
 
+      - name: Check if package-lock.json changed
+        run: |
+          npm install
+          # Check if package-lock.json changed
+          if ! git diff --exit-code --quiet package-lock.json; then
+            echo "package-lock.json has changed"
+            git add package-lock.json
+            git commit -m "chore(terra-draw): automated update package-lock.json during CI release"
+          else
+            echo "No changes to package-lock.json"
+          fi
+
       - name: Push upstream
         run: git push origin main
 

packages/terra-draw-maplibre-gl-adapter/README.md

@@ -1,7 +1,26 @@
 # TerraDrawMapLibreGLAdapter
 
-This package is for the Terra Draw MapLibreGL JS Adapter. You can find out more about what adapters are and how to use them in [the adapters guide](./../../guides/3.ADAPTERS.md). For a broader introduction to Terra Draw, check out the main [README](../../README.md) and the [getting started guide](../../guides/1.GETTING_STARTED.md).
+This package is for the [Terra Draw](https://www.github.com/JamesLMilner/terra-draw) MapLibreGL JS Adapter. The package is designed be used in conjunction with the [`maplibre-gl` package](https://www.npmjs.com/package/maplibre-gl).
+
+## Getting Started
+
+For full getting started instructions for Terra Draw please read the [getting started guide in the GitHub repository](https://github.com/JamesLMilner/terra-draw/blob/main/guides/1.GETTING_STARTED.md). To get started with the MapboxGL adapter, please see the detailed [guide on adapters in the GitHub repository](https://github.com/JamesLMilner/terra-draw/blob/main/guides/3.ADAPTERS.md) to understand which are supported and how to get started with them. The guide has a specific section on the [TerraDrawMapLibreGLAdapter](https://github.com/JamesLMilner/terra-draw/blob/main/guides/3.ADAPTERS.md#maplibre).
+
+
+#### Installation
+
+Installing the core package and this adapter can be done like so:
+
+```shell
+npm install terra-draw terra-draw-maplibre-gl-adapter
+```
+
+#### Quick Links
+
+* [TerraDrawMapLibreGLAdapter API Docs](https://jameslmilner.github.io/terra-draw/classes/terra_draw_maplibre_gl_adapter.TerraDrawMapLibreGLAdapter.html)
+* [GitHub Repository](https://www.github.com/JamesLMilner/terra-draw)
+* [Website](https://terradraw.io)
 
 ## License 
 
-[MIT](../../LICENSE)
+[MIT](https://github.com/JamesLMilner/terra-draw/blob/main/LICENSE)