From b9de0fe517de20f7eecf0bc2c943d65e76aaaaae Mon Sep 17 00:00:00 2001 From: "leonardo.gabriel" Date: Thu, 7 Jul 2022 12:21:33 -0300 Subject: [PATCH] Updated Readme --- CHANGELOG.md | 4 ++++ README.md | 40 ++++++++++------------------------------ pubspec.yaml | 2 +- 3 files changed, 15 insertions(+), 31 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9239de1d..9cb17d50 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +## 0.0.4 + +* Updated README + ## 0.0.3 * Changed pub credentials location diff --git a/README.md b/README.md index 8b55e735..826cb9b5 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,19 @@ - +This project was born based on the need to create a Design System to be used within Take. The components are written using the Flutter Framework. -TODO: Put a short description of the package here that helps potential users -know whether this package might be useful for them. +Components. Guides. Brands. It's all here, no riddles. The Blip-DS is all yours. [Blip-DS](https://design.take.net/240287753/p/9953dc-take-blip-ds-elementar). -## Features +![thumbnail-components](./src/assets/svg/thumbnail-github.svg). -TODO: List what your package can do. Maybe include images, gifs, or videos. +## Installation -## Getting started +Blip-DS installation is available in [Blip-DS](https://design.take.net/240287753/p/216ef2-instalao/b/8176c4). -TODO: List prerequisites and provide or point to information on how to -start using the package. -## Usage +## License -TODO: Include short and useful examples for package users. Add longer examples -to `/example` folder. - -```dart -const like = 'sample'; -``` - -## Additional information - -TODO: Tell users more about the package: where to find more information, how to -contribute to the package, how to file issues, what response they can expect -from the package authors, and more. +`blip-ds` is under the [ISC license](https://opensource.org/licenses/ISC). diff --git a/pubspec.yaml b/pubspec.yaml index 7b73c1a8..aec8bc18 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,6 +1,6 @@ name: blip_ds description: Blip Design System for Flutter. -version: 0.0.3 +version: 0.0.4 homepage: https://github.com/takenet/blip-ds-flutter#readme repository: https://github.com/takenet/blip-ds-flutter