Skip to content

Commit d5152b7

Browse files
committed
docs: add badges and improve README layout
1 parent 9648b22 commit d5152b7

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,24 @@
11
# flutter_json_render
22

3+
[![pub package](https://img.shields.io/pub/v/flutter_json_render.svg)](https://pub.dev/packages/flutter_json_render)
4+
[![pub points](https://img.shields.io/pub/points/flutter_json_render)](https://pub.dev/packages/flutter_json_render/score)
5+
[![pub likes](https://img.shields.io/pub/likes/flutter_json_render)](https://pub.dev/packages/flutter_json_render/score)
6+
[![Secret Scan](https://github.com/Dev-Beom/flutter-json-render/actions/workflows/secret-scan.yml/badge.svg)](https://github.com/Dev-Beom/flutter-json-render/actions/workflows/secret-scan.yml)
7+
[![license](https://img.shields.io/github/license/Dev-Beom/flutter-json-render)](LICENSE)
8+
[![stars](https://img.shields.io/github/stars/Dev-Beom/flutter-json-render?style=social)](https://github.com/Dev-Beom/flutter-json-render/stargazers)
9+
310
A Flutter-first implementation of the [vercel-labs/json-render](https://github.com/vercel-labs/json-render) concept.
411

512
`flutter_json_render` renders flat JSON specs into Flutter widgets through an explicit registry and catalog.
613

14+
Quick links:
15+
16+
- Package: [pub.dev/flutter_json_render](https://pub.dev/packages/flutter_json_render)
17+
- Source: [github.com/Dev-Beom/flutter-json-render](https://github.com/Dev-Beom/flutter-json-render)
18+
- Example app: [`/example`](https://github.com/Dev-Beom/flutter-json-render/tree/main/example)
19+
20+
## Highlights
21+
722
- Guardrailed component/action model
823
- Flat and model-friendly spec shape (`root + elements`)
924
- Dynamic prop resolution (`$state`, `$item`, `$index`, `$cond`)
@@ -17,6 +32,16 @@ A Flutter-first implementation of the [vercel-labs/json-render](https://github.c
1732
flutter pub add flutter_json_render
1833
```
1934

35+
## Table of Contents
36+
37+
- [Core Concepts](#core-concepts)
38+
- [Quick Start](#quick-start)
39+
- [Stream JSONL Patches](#stream-jsonl-patches)
40+
- [Validate Specs](#validate-specs)
41+
- [Built-In Components](#built-in-components)
42+
- [Example App](#example-app)
43+
- [Security Scanning](#security-scanning)
44+
2045
## Core Concepts
2146

2247
- `JsonCatalog`: declares what components/actions are allowed

0 commit comments

Comments
 (0)