From d4f647c0db9cfb92177da1bee9b234ea9851fee3 Mon Sep 17 00:00:00 2001 From: dswbx Date: Fri, 17 Jan 2025 05:29:13 +0100 Subject: [PATCH] add readme to npm publish, updated package.json and README.md --- README.md | 6 +++++- app/package.json | 30 ++++++++++++++++++++++++++++-- 2 files changed, 33 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b60a344..7f47c83 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ -![bknd](docs/_assets/poster.png) +[![npm version](https://img.shields.io/npm/v/bknd.svg)](https://npmjs.org/package/bknd +"View this project on NPM") +[![npm downloads](https://img.shields.io/npm/dm/bknd)](https://www.npmjs.com/package/bknd) + +![bknd](https://raw.githubusercontent.com/bknd-io/bknd/refs/heads/main/docs/_assets/poster.png) bknd simplifies app development by providing fully functional backend for data management, authentication, workflows and media. Since it's lightweight and built on Web Standards, it can diff --git a/app/package.json b/app/package.json index c016cd8..b96ccd8 100644 --- a/app/package.json +++ b/app/package.json @@ -3,7 +3,16 @@ "type": "module", "sideEffects": false, "bin": "./dist/cli/index.js", - "version": "0.6.0-rc.0", + "version": "0.6.0-rc.3", + "description": "Lightweight Firebase/Supabase alternative built to run anywhere — incl. Next.js, Remix, Astro, Cloudflare, Bun, Node, AWS Lambda & more.", + "homepage": "https://bknd.io", + "repository": { + "type": "git", + "url": "https://github.com/bknd-io/bknd.git" + }, + "bugs": { + "url": "https://github.com/bknd-io/bknd/issues" + }, "scripts": { "dev": "vite", "test": "ALL_TESTS=1 bun test --bail", @@ -18,7 +27,8 @@ "build:types": "tsc --emitDeclarationOnly && tsc-alias", "updater": "bun x npm-check-updates -ui", "cli": "LOCAL=1 bun src/cli/index.ts", - "prepublishOnly": "bun run types && bun run test && bun run build:all" + "prepublishOnly": "bun run types && bun run test && bun run build:all && cp ../README.md ./", + "postpublish": "rm -f README.md" }, "license": "FSL-1.1-MIT", "dependencies": { @@ -186,5 +196,21 @@ "!dist/**/*.map", "!dist/metafile*", "!dist/**/metafile*" + ], + "keywords": [ + "api", + "backend", + "database", + "authentication", + "jwt", + "workflows", + "media", + "serverless", + "cloudflare", + "nextjs", + "remix", + "astro", + "bun", + "node" ] }