From e51206366de0b8123323aeb6abbd5d70aec4ef3d Mon Sep 17 00:00:00 2001 From: David Enke Date: Sun, 20 Oct 2024 22:56:19 +0200 Subject: [PATCH] docs: add badges and meta data --- README.md | 16 +++++++++++++++- package.json | 14 ++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 245f6b1..865e6c6 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,22 @@ +NPM version +Test and build status +Test and build status + # Astro Decap Collection Derive [Astro content collection](https://docs.astro.build/en/guides/content-collections/) schemata from [Decap collection configs](https://decapcms.org/docs/configuration-options/#collections). -The procedure is to transform a Decap config into a [Zod schema](https://zod.dev/?id=basic-usage) by mapping the [Decap widget fields](https://decapcms.org/docs/widgets/) with custom [transformers](./src/transformers/). +The procedure is to transform a Decap config into a [Zod schema](https://zod.dev/?id=basic-usage) by mapping the [Decap widget fields](https://decapcms.org/docs/widgets/) with custom [transformers](https://github.com/davidenke/astro-decap-collection/tree/main/src/transformers/). + +## Installation + +```bash +npm i -D astro-decap-collection +# or +pnpm add -D astro-decap-collection +# or +yarn add -D astro-decap-collection +``` ## Usage diff --git a/package.json b/package.json index 848af01..5a71bdb 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,21 @@ { "name": "astro-decap-collection", "version": "0.0.2", + "license": "MIT", "description": "Derive Astro collection schemata from Decap configs.", + "author": { + "name": "David Enke", + "email": "david@enke.dev" + }, + "keywords": [ + "astro", + "decap", + "convert", + "transform", + "config", + "collection", + "schema" + ], "main": "./dist/index.js", "module": "./dist/index.js", "types": "dist/index.d.ts",