Merge pull request #2 from louisescher/feat/npm-package

Author: louisescher

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "../node_modules/@changesets/config/schema.json",
+  "changelog": ["@changesets/changelog-github", { "repo": "louisescher/astro-webrings" }],
+  "ignore": ["web"],
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "master",
+  "updateInternalDependencies": "patch"
+}

.changeset/full-clouds-grow.md

@@ -0,0 +1,5 @@
+---
+"astro-webrings": minor
+---
+
+Initial release

.github/actions/install/action.yml

@@ -0,0 +1,18 @@
+name: Install Tools & Dependencies
+description: Installs pnpm, Node.js & package dependencies
+
+runs:
+  using: composite
+  steps:
+    - name: Setup pnpm
+      uses: pnpm/action-setup@v3
+
+    - name: Setup Node.js based on .node-version
+      uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4
+      with:
+        node-version-file: '.node-version'
+        cache: 'pnpm'
+
+    - name: Install Dependencies
+      run: pnpm install --frozen-lockfile
+      shell: bash

.github/workflows/ci-push-master.yml

@@ -0,0 +1,43 @@
+name: CI - Push to Master
+
+on:
+  push:
+    branches:
+      - master
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+permissions:
+  issues: write
+  repository-projects: read
+  contents: write
+  pull-requests: write
+  pages: write
+  id-token: write
+
+jobs:
+  changeset-release:
+    name: Changeset Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+
+      - name: Install Tools & Dependencies
+        uses: louisescher/astro-webrings/.github/actions/install@master
+
+      - name: Run Prepublish
+        run: pnpm ci:prepublish
+
+      - name: Create Release Pull Request or Publish to npm
+        id: changesets
+        uses: changesets/action@v1
+        with:
+            setupGitUser: true
+            commit: "👷 [ci]: Version Packages"
+            title: "👷 [ci]: Ready for Release"
+            version: pnpm ci:version
+            publish: pnpm ci:publish
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.node-version

@@ -0,0 +1 @@
+v22.20.0

README.md

@@ -0,0 +1 @@
+./packages/web/README.md

README.md

@@ -25,7 +25,7 @@
       "indentStyle": "space"
     }
   },
-  "assist": { "actions": { "source": { "organizeImports": "on" } } },
+  "assist": { "actions": { "source": { "organizeImports": "off" } } },
   "linter": {
     "enabled": true,
     "rules": {

biome.json

@@ -1,18 +1,28 @@
-{
-  "name": "astro-webring",
-  "type": "module",
-  "version": "0.0.1",
-  "packageManager": "pnpm@10.17.1",
-  "scripts": {
-    "dev": "astro dev",
-    "build": "astro build",
-    "preview": "astro preview",
-    "astro": "astro",
-    "start": "node ./dist/server/entry.mjs"
-  },
-  "dependencies": {
-    "@astrojs/node": "^9.4.4",
-    "astro": "^5.14.1",
-    "@biomejs/biome": "^2.2.4"
-  }
-}
+{
+	"name": "root",
+	"private": true,
+	"packageManager": "pnpm@10.17.1",
+	"license": "MIT",
+	"author": {
+		"name": "Louis Escher",
+		"url": "https://lou.gg"
+	},
+	"type": "module",
+	"scripts": {
+		"build": "pnpm --filter astro-webrings build && pnpm --filter web build",
+		"dev": "pnpm --stream -r -parallel dev",
+		"start": "pnpm --filter web start",
+		"changeset": "changeset",
+		"ci:prepublish": "pnpm build",
+		"ci:install": "pnpm install --frozen-lockfile",
+		"ci:version": "pnpm changeset version",
+		"ci:publish": "pnpm changeset publish"
+	},
+	"devDependencies": {
+		"@changesets/changelog-github": "0.5.1",
+		"@changesets/cli": "2.29.7",
+		"@changesets/config": "3.1.1",
+		"@changesets/write": "0.4.0",
+		"@biomejs/biome": "^2.2.4"
+	}
+}

package.json

@@ -0,0 +1,33 @@
+# astro-webrings
+
+Add webring badges for astro-webrings.lou.gg to your Astro site with ease!
+
+## Installation
+
+You can install the package from the NPM:
+
+```bash
+# npm
+npm install astro-webrings
+
+# pnpm
+pnpm add astro-webrings
+
+# yarn
+yarn add astro-webrings
+```
+
+Once installed, you can import the component to add a badge to your site:
+
+```jsx
+---
+import WebringBadge from "astro-webrings/badge";
+---
+
+<WebringBadge site="example.com" ring="friends-of-houston" />
+```
+
+Make sure that the `site` prop matches the slug you chose in your PR to the [`astro-webrings`](https://github.com/louisescher/astro-webrings) repository and the `ring` prop matches the ring you added your site to. Otherwise, people will see errors when clicking on the badge!
+
+### Animated Badges
+If you can see an animated version of the badge you want to use in the [webrings list](https://astro-webrings.lou.gg/#available-webrings), you can set the `animated` prop to use that version instead.