Skip to content

Commit 974dc7b

Browse files
committed
docs: update installation instructions and add experimental badge to schemas
1 parent d2a1507 commit 974dc7b

File tree

3 files changed

+18
-1
lines changed

3 files changed

+18
-1
lines changed

docs/advanced/schema.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Schemas
1+
# Schemas ![Static Badge](https://img.shields.io/badge/experimental-orange)
22

33
The library can **generate schema definitions** for all converters that support it and can **also regenerate**
44
'materialize' **structures** from those **schema definitions**. The schema definition format is JSON-based and a

docs/flutter/index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,18 @@ This package provides Flutter specific functionality for the Dogs serialization
88

99
- [Databinding](binding) and Form Generation
1010
- [Converters](converters) for Flutter specific types
11+
12+
13+
To install the base package, modify your `pubspec.yaml` to include following packages:
14+
15+
``` { .yaml .file .focus title="pubspec.yaml" hl_lines="3" }
16+
dependencies:
17+
dogs_core: any
18+
dogs_flutter: any
19+
20+
dev_dependencies:
21+
build_runner: any
22+
dogs_generator: any
23+
```
24+
25+
and replace the `any` with the desired/latest version constraint.

docs/installation.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ dependencies:
2323
dogs_cbor: any # Support for CBOR files
2424
```
2525

26+
Also replace the `any` values with the desired/latest version constraints.
27+
2628
After adding the packages, run `pub get` to download the packages and `pub run build_runner build`
2729
to generate the `dogs.g.dart` reactor file.
2830

0 commit comments

Comments
 (0)