Skip to content

Commit

Permalink
docs: add badges and meta data
Browse files Browse the repository at this point in the history
  • Loading branch information
davidenke committed Oct 20, 2024
1 parent 9d267b6 commit e512063
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
<a href="https://www.npmjs.com/package/astro-decap-collection"><img src="https://img.shields.io/npm/v/astro-decap-collection?style=for-the-badge&label=npm%20%40latest&logo=npm" alt="NPM version"/></a>
<a href="https://github.com/davidenke/astro-decap-collection/actions/workflows/main.yml"><img src="https://img.shields.io/github/actions/workflow/status/davidenke/astro-decap-collection/main.yml?style=for-the-badge&label=tests%20%2B%20build&logo=github" alt="Test and build status"/></a>
<a href="https://github.com/davidenke/astro-decap-collection"><img src="https://img.shields.io/badge/github-sources-blue?style=for-the-badge&logo=github" alt="Test and build status"/></a>

# 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

Expand Down
14 changes: 14 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -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": "[email protected]"
},
"keywords": [
"astro",
"decap",
"convert",
"transform",
"config",
"collection",
"schema"
],
"main": "./dist/index.js",
"module": "./dist/index.js",
"types": "dist/index.d.ts",
Expand Down

0 comments on commit e512063

Please sign in to comment.