Skip to content

Commit 2a2da40

Browse files
authored
Merge pull request #69 from CodandoTV/gmoro/update-readme
Gmoro/update readme
2 parents 6450b95 + 5f0654a commit 2a2da40

File tree

5 files changed

+41
-7
lines changed

5 files changed

+41
-7
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22
[![kotlin](https://img.shields.io/github/languages/top/codandotv/craftd.svg?style=for-the-badge&color=blueviolet)](https://kotlinlang.org/)
33
[![License MIT](https://img.shields.io/github/license/codandotv/craftd.svg?style=for-the-badge&color=orange)](https://opensource.org/licenses/MIT)
44

5+
![Logo do CodandoTV](readme-files/codandotv.png)
56

67
<h1 align="center">
78
<img height="150" src="https://github.com/user-attachments/assets/6893bd0d-7866-44b0-bc34-5c3759c1bacf"/>
89
<br>
9-
<a href="https://codandotv.gitbook.io/craftd">CraftD</a>: A framework to implement Server-Driven UI quickly and easily to Android / iOS / Flutter / Kmp
10+
<a href="https://codandotv.github.io/CraftD">CraftD</a>: A framework to implement Server-Driven UI quickly and easily to Android / iOS / Flutter / Kmp
1011
</h1>
1112

1213
### Documentation
13-
See the [project website](https://codandotv.gitbook.io/craftd) for documentation.
14+
See the [project website](https://codandotv.github.io/CraftD) for documentation.
1415

1516
Take a look at [CraftD: Server Driven UI for All Platforms](https://medium.com/codandotv/craftd-server-driven-ui-for-all-platforms-b2624d2c2a7b)
1617

17-
1818
## Features
1919
### 🔗 Compatibility
2020

flutter/craftd_widget/CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
## 1.0.2
2+
3+
- Update README.md adding CodandoTV keyword.
4+
5+
## 1.0.1
6+
7+
- Documentation improvements.
8+
19
## 1.0.0
210

311
- Stable version milestone

flutter/craftd_widget/README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,35 @@
11
## 🧑‍💻 How to use?
22

3-
You can use the existing components or create your own components, more details you can check in our [documentation](./docs/index.md).
3+
You can use the existing components or create your own components, more details you can check in our [documentation web site](https://codandotv.github.io/CraftD).
44

55
### Existing Components
66

7+
You can check the existing components CraftD already has [here](https://codandotv.github.io/CraftD/#components-that-already-exist-in-the-library).
8+
79
### Create your own component
810

9-
## 🔗 Compatibility
11+
- Create your ComponentPropertyClass with properties that you need
12+
13+
```dart
14+
class ButtonProperties {
15+
const ButtonProperties({
16+
required this.text,
17+
... place your construtor properties
18+
});
19+
20+
final String text;
21+
... place your properties
22+
}
23+
```
24+
25+
- Add your Component json object in Dymanic.json
26+
27+
```json
28+
{
29+
"key": "CraftDBbutton",
30+
"value": {
31+
"text": "Knife",
32+
... place your properties
33+
}
34+
}
35+
```

flutter/craftd_widget/pubspec.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: craftd_widget
2-
description: Create dynamic form screens using Server Driven UI concepts using CraftD
3-
version: 1.0.0
2+
description: A Server Driven UI library provided by CodandoTV.
3+
version: 1.0.2
44
homepage: https://github.com/CodandoTV/CraftD
55

66
environment:

readme-files/codandotv.png

183 KB
Loading

0 commit comments

Comments
 (0)