From 5ec2561fa85162993a343dc29bad6d29a65900f5 Mon Sep 17 00:00:00 2001 From: Luke Walton Date: Wed, 13 Mar 2024 10:04:12 +0000 Subject: [PATCH] fix: adding more files to pubignore to make package smaller (#8) --- .pubignore | 7 ++++++- README.md | 14 +++++++++++--- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/.pubignore b/.pubignore index a355fc4..8db1d9c 100644 --- a/.pubignore +++ b/.pubignore @@ -1,3 +1,8 @@ test/ build/ -_localizations/ \ No newline at end of file +_localizations/ +doc/ +example/* +!*.md +firebase.json +release-please-config.json \ No newline at end of file diff --git a/README.md b/README.md index 114ea17..b0b26d8 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ # ZDS Flutter A library of Flutter components made by Zebra Technologies based on the Zebra Design System, or ZDS. - + + zds_flutter example + ## Requirements @@ -19,11 +21,17 @@ Make sure your app meets the following requirements before using ZDS Flutter Add the following as a dependency in your pubspec.yaml file. ```yml -zds-flutter: ^1.0.1 +zds-flutter: ^1.1.0 ``` ## Getting started +### Template + +To speed up development, we have a template repo with ZDS Flutter already set up: [zds_flutter_template](https://github.com/ZebraDevs/zds_flutter_template) + +### Manual setup + In order to use components from ZDS Flutter, you must change your app widget to be a `ZdsApp` ```dart @@ -43,7 +51,7 @@ class DemoApp extends StatelessWidget { ## Viewing the components -To view examples of all the components in the library, you can run the example app in this repo or go to [this link](https://zebradevs.github.io/zds_flutter). +To view examples of all the components in the library, you can run the example app in this repo or go to [this link](https://zds-c9c24.web.app/). ## Theming