add readme to npm publish, updated package.json and README.md

This commit is contained in:
dswbx
2025-01-17 05:29:13 +01:00
parent ad3fceaf60
commit d4f647c0db
2 changed files with 33 additions and 3 deletions

View File

@@ -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, 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 authentication, workflows and media. Since it's lightweight and built on Web Standards, it can

View File

@@ -3,7 +3,16 @@
"type": "module", "type": "module",
"sideEffects": false, "sideEffects": false,
"bin": "./dist/cli/index.js", "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": { "scripts": {
"dev": "vite", "dev": "vite",
"test": "ALL_TESTS=1 bun test --bail", "test": "ALL_TESTS=1 bun test --bail",
@@ -18,7 +27,8 @@
"build:types": "tsc --emitDeclarationOnly && tsc-alias", "build:types": "tsc --emitDeclarationOnly && tsc-alias",
"updater": "bun x npm-check-updates -ui", "updater": "bun x npm-check-updates -ui",
"cli": "LOCAL=1 bun src/cli/index.ts", "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", "license": "FSL-1.1-MIT",
"dependencies": { "dependencies": {
@@ -186,5 +196,21 @@
"!dist/**/*.map", "!dist/**/*.map",
"!dist/metafile*", "!dist/metafile*",
"!dist/**/metafile*" "!dist/**/metafile*"
],
"keywords": [
"api",
"backend",
"database",
"authentication",
"jwt",
"workflows",
"media",
"serverless",
"cloudflare",
"nextjs",
"remix",
"astro",
"bun",
"node"
] ]
} }