Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: adding more files to pubignore to make package smaller #8

Merged
merged 3 commits into from
Mar 13, 2024
Merged

fix: adding more files to pubignore to make package smaller #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
752f05d
adding more files to pubignore to make package smaller
thelukewalton Mar 8, 2024
7cb6f57
fixing old url
thelukewalton Mar 11, 2024
94c1c19
update readme
thelukewalton Mar 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .pubignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
test/
build/
_localizations/
_localizations/
doc/
example/*
!*.md
firebase.json
release-please-config.json
14 changes: 11 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# ZDS Flutter

A library of Flutter components made by Zebra Technologies based on the Zebra Design System, or ZDS.

<a href='https://zds-c9c24.web.app/'>
<picture>

<source media="(prefers-color-scheme: dark)" srcset="doc/assets/zds-dark.png">
<img alt="zds_flutter example" src="doc/assets/zds-light.png">
</picture>
</a>

## Requirements

Expand All @@ -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
Expand All @@ -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

Expand Down