prepare for npmjs

webxdc · Nov 14, 2024 · d85de87 · d85de87
1 parent fa83109
commit d85de87
Show file tree

Hide file tree

Showing 16 changed files with 30 additions and 33 deletions.
diff --git a/.gitignore b/.gitignore
@@ -10,4 +10,6 @@ node_modules
 .DS_Store
 *~
 
-example/pnpm-lock.yaml
+example/pnpm-lock.yaml
+example/dist
+example/dist-xdc
diff --git a/README.md b/README.md
@@ -1,16 +1,17 @@
-# webxdc-scores
+# Highscores
 
 Library to facilitate the process of creating score-based webxdc games.
+It can handle multiple scoreboards at the same time.
 
 ## Install
 
 ```
-npm install git+https://github.com/webxdc/webxdc-scores.git
+npm install @webxdc/highscores
 ```
 
 ## Usage
 
-Import webxdc-scores lib (`webxdc.js` also needs to be included) in your `index.html`:
+Import `@webxdc/highscores` lib (`webxdc.js` also needs to be included) in your `index.html`:
 
 ```html
 <html>
@@ -20,7 +21,7 @@ Import webxdc-scores lib (`webxdc.js` also needs to be included) in your `index.
     <script src="webxdc.js"></script>
 
     <script type="module">
-      import "webxdc-scores";
+      import "@webxdc/highscores";
       // you can use window.highscores here
     </script>
   </head>
@@ -41,14 +42,14 @@ Include webxdc-scores lib (together with `webxdc.js`) in your `index.html`:
     <meta name="viewport" content="width=device-width" />
 
     <script src="webxdc.js"></script>
-    <script src="./node_modules/webxdc-scores/dist/webxdc-scores.umd.js"></script>
+    <script src="./node_modules/@webxdc/highscores/dist/webxdc-scores.umd.js"></script>
   </head>
   <body>
     ...
   </body>
 </html>
 ```
 
-Then you will have an scores API via `window.highscores` object, check [dist/webxdc-scores.d.ts](https://github.com/webxdc/webxdc-scores/blob/main/dist/webxdc-scores.d.ts) file for documentation of the available API.
+Then you can access the API via `window.highscores` object, check [dist/webxdc-scores.d.ts](https://github.com/webxdc/highscores/blob/main/dist/webxdc-scores.d.ts) file for documentation of the available API.
 
-For a full example check the [example/index.html](https://github.com/webxdc/webxdc-scores/blob/main/example/index.html) file.
+For a full example check the [example/index.html](https://github.com/webxdc/highscores/blob/main/example/index.html) file.
diff --git a/dist/webxdc-scores.css → dist/highscores.css b/dist/webxdc-scores.css → dist/highscores.css
diff --git a/dist/webxdc-scores.d.ts → dist/highscores.d.ts b/dist/webxdc-scores.d.ts → dist/highscores.d.ts
diff --git a/dist/webxdc-scores.mjs → dist/highscores.mjs b/dist/webxdc-scores.mjs → dist/highscores.mjs
diff --git a/dist/highscores.umd.js b/dist/highscores.umd.js
diff --git a/dist/webxdc-scores.umd.js b/dist/webxdc-scores.umd.js
diff --git a/example/.gitignore b/example/.gitignore
diff --git a/example/.prettierignore b/example/.prettierignore
diff --git a/example/index.html b/example/index.html
@@ -6,7 +6,7 @@
     <script src="webxdc.js"></script>
     <link
       rel="stylesheet"
-      href="./node_modules/webxdc-scores/dist/webxdc-scores.css"
+      href="./node_modules/@webxdc/highscores/dist/highscores.css"
     />
     <style>
       html,
@@ -36,7 +36,7 @@ <h3>Score: <span id="self-score">0</span></h3>
     </p>
     <div id="scoreboard"></div>
     <script type="module">
-      import "webxdc-scores";
+      import "@webxdc/highscores";
       const scoreboard = document.getElementById("scoreboard");
 
       await window.highscores.init({

diff --git a/example/package.json b/example/package.json
@@ -1,8 +1,8 @@
 {
   "type": "module",
   "scripts": {
-    "build": "vite build",
     "start": "vite --port 3000",
+    "build": "vite build",
     "emulator": "concurrently \"npm run start\" \"webxdc-dev run http://localhost:3000\"",
     "fix": "prettier --write .",
     "check": "prettier --check ."
@@ -15,6 +15,6 @@
     "webxdc-vite-plugins": "github:webxdc/webxdc-vite-plugins"
   },
   "dependencies": {
-    "webxdc-scores": "github:webxdc/webxdc-scores"
+    "webxdc-scores": "@webxdc/highscores"
   }
 }
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "webxdc-scores",
+  "name": "@webxdc/highscores",
   "description": "Highscores API for webxdc apps",
   "version": "4.0.1",
   "license": "MIT",
@@ -10,25 +10,25 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/webxdc/webxdc-scores.git"
+    "url": "https://github.com/webxdc/highscores.git"
   },
   "bugs": {
-    "url": "https://github.com/webxdc/webxdc-scores/issues"
+    "url": "https://github.com/webxdc/highscores/issues"
   },
-  "homepage": "https://github.com/webxdc/webxdc-scores",
-  "main": "./dist/webxdc-scores.umd.js",
-  "module": "./dist/webxdc-scores.mjs",
-  "types": "./dist/webxdc-scores.d.ts",
-  "source": "./src/webxdc-scores.js",
+  "homepage": "https://github.com/webxdc/highscores",
+  "main": "./dist/highscores.umd.js",
+  "module": "./dist/highscores.mjs",
+  "types": "./dist/highscores.d.ts",
+  "source": "./src/highscores.js",
   "files": [
     "dist"
   ],
   "exports": {
     ".": {
-      "import": "./dist/webxdc-scores.mjs",
-      "require": "./dist/webxdc-scores.umd.js"
+      "import": "./dist/highscores.mjs",
+      "require": "./dist/highscores.umd.js"
     },
-    "./dist/webxdc-scores.css": "./dist/webxdc-scores.css"
+    "./dist/highscores.css": "./dist/highscores.css"
   },
   "scripts": {
     "build": "vite build",

diff --git a/public/webxdc-scores.css → public/highscores.css b/public/webxdc-scores.css → public/highscores.css
diff --git a/public/webxdc-scores.d.ts → public/highscores.d.ts b/public/webxdc-scores.d.ts → public/highscores.d.ts
diff --git a/src/webxdc-scores.js → src/highscores.js b/src/webxdc-scores.js → src/highscores.js
diff --git a/vite.config.js b/vite.config.js
@@ -6,10 +6,10 @@ export default defineConfig({
   build: {
     lib: {
       // Could also be a dictionary or array of multiple entry points
-      entry: resolve(__dirname, "src/webxdc-scores.js"),
-      name: "webxdc-scores",
+      entry: resolve(__dirname, "src/highscores.js"),
+      name: "@webxdc/highscores",
       // the proper extensions will be added
-      fileName: "webxdc-scores",
+      fileName: "highscores",
     },
   },
 });