diff --git a/README.md b/README.md index 79284eb..e64cebf 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,19 @@ [![kotlin](https://img.shields.io/github/languages/top/codandotv/craftd.svg?style=for-the-badge&color=blueviolet)](https://kotlinlang.org/) [![License MIT](https://img.shields.io/github/license/codandotv/craftd.svg?style=for-the-badge&color=orange)](https://opensource.org/licenses/MIT) +![Logo do CodandoTV](readme-files/codandotv.png)


- CraftD: A framework to implement Server-Driven UI quickly and easily to Android / iOS / Flutter / Kmp + CraftD: A framework to implement Server-Driven UI quickly and easily to Android / iOS / Flutter / Kmp

### Documentation -See the [project website](https://codandotv.gitbook.io/craftd) for documentation. +See the [project website](https://codandotv.github.io/CraftD) for documentation. Take a look at [CraftD: Server Driven UI for All Platforms](https://medium.com/codandotv/craftd-server-driven-ui-for-all-platforms-b2624d2c2a7b) - ## Features ### 🔗 Compatibility diff --git a/flutter/craftd_widget/CHANGELOG.md b/flutter/craftd_widget/CHANGELOG.md index 1aa1a2d..178dd36 100644 --- a/flutter/craftd_widget/CHANGELOG.md +++ b/flutter/craftd_widget/CHANGELOG.md @@ -1,3 +1,11 @@ +## 1.0.2 + +- Update README.md adding CodandoTV keyword. + +## 1.0.1 + +- Documentation improvements. + ## 1.0.0 - Stable version milestone diff --git a/flutter/craftd_widget/README.md b/flutter/craftd_widget/README.md index 0b0e672..6dcb42c 100644 --- a/flutter/craftd_widget/README.md +++ b/flutter/craftd_widget/README.md @@ -1,9 +1,35 @@ ## 🧑‍💻 How to use? -You can use the existing components or create your own components, more details you can check in our [documentation](./docs/index.md). +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). ### Existing Components +You can check the existing components CraftD already has [here](https://codandotv.github.io/CraftD/#components-that-already-exist-in-the-library). + ### Create your own component -## 🔗 Compatibility +- Create your ComponentPropertyClass with properties that you need + +```dart +class ButtonProperties { + const ButtonProperties({ + required this.text, + ... place your construtor properties + }); + + final String text; + ... place your properties +} +``` + +- Add your Component json object in Dymanic.json + +```json +{ + "key": "CraftDBbutton", + "value": { + "text": "Knife", + ... place your properties + } + } +``` diff --git a/flutter/craftd_widget/pubspec.yaml b/flutter/craftd_widget/pubspec.yaml index b22cd18..46cf02d 100644 --- a/flutter/craftd_widget/pubspec.yaml +++ b/flutter/craftd_widget/pubspec.yaml @@ -1,6 +1,6 @@ name: craftd_widget -description: Create dynamic form screens using Server Driven UI concepts using CraftD -version: 1.0.0 +description: A Server Driven UI library provided by CodandoTV. +version: 1.0.2 homepage: https://github.com/CodandoTV/CraftD environment: diff --git a/readme-files/codandotv.png b/readme-files/codandotv.png new file mode 100644 index 0000000..cb3c0ad Binary files /dev/null and b/readme-files/codandotv.png differ