build: Prepare repo for publishing to npm (#35)

purplebugs · Aug 12, 2024 · aae75da · aae75da
1 parent 3e34671
commit aae75da
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 87 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# Lit Playground ⛹️‍♀️
+# Alpaca Map Web Component 🦙
 
-To try out creating web components using [lit](https://lit.dev/)
+Web component created using [lit](https://lit.dev/)
 
 ## Audience 🗺️
 
@@ -16,17 +16,19 @@ To try out creating web components using [lit](https://lit.dev/)
    <link href="/assets/fonts_google/poppins/fonts.css" rel="stylesheet" />
    ```
 
-1. Copy and paste the following code inside the `<body></body>` tag of website where the component should appear
+1. Generate a [google maps API key](https://developers.google.com/maps/documentation/javascript/get-api-key)
 
-   ```
-   <alpaca-map key="-TODO-"></alpaca-map>
-   ```
+1. Copy and paste the following code inside the `<body></body>` tag of website where the component should appear, replacing `GOOGLE-API-KEY` with your key
+
+```
+<alpaca-map key="GOOGLE-API-KEY"></alpaca-map>
+```
 
 1. Optional. To center the map on a favourite farm, replace the latitude and longitude with its `centerLat` and `centerLng` coordinates
 
-   ```
-   <alpaca-map key="-TODO-" centerLat="-33.8688" centerLng="151.2093"></alpaca-map>
-   ```
+```
+   <alpaca-map key="GOOGLE-API-KEY" centerLat="-33.8688" centerLng="151.2093"></alpaca-map>
+```
 
 ## For developers 🤖
 

diff --git a/package.json b/package.json
@@ -1,8 +1,13 @@
 {
-  "name": "map-component",
+  "name": "@purplebugs/alpaca-map",
   "type": "module",
-  "version": "1.0.0",
-  "main": "src/index.js",
+  "version": "0.0.1",
+  "main": "src/alpaca-map.js",
+  "files": [
+    "package.json",
+    "README.md",
+    "src"
+  ],
   "scripts": {
     "build:watch": "node --watch-path=./src build.js",
     "build": "node build.js",

diff --git a/public/element.html b/public/element.html
diff --git a/src/element.js b/src/element.js