Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jesusrp98 authored Apr 28, 2019
1 parent e534458 commit 9d688a7
Showing 1 changed file with 30 additions and 9 deletions.
39 changes: 30 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,35 @@
# row_collection
# Row Collection
[![Package](https://img.shields.io/pub/v/row_collection.svg?style=for-the-badge)](https://pub.dartlang.org/packages/row_collection)
[![License](https://img.shields.io/github/license/jesusrp98/row_collection.svg?style=for-the-badge)](https://www.gnu.org/licenses/gpl-3.0.en.html)
[![Stars](https://img.shields.io/github/stars/jesusrp98/row_collection.svg?style=for-the-badge)](https://github.com/jesusrp98/row_collection/stargazers)
[![PayPal](https://img.shields.io/badge/Donate-PayPal-blue.svg?style=for-the-badge)](https://www.paypal.com/paypalme/my/profile)
[![Patreon](https://img.shields.io/badge/Support-Patreon-orange.svg?style=for-the-badge)](https://www.patreon.com/jesusrp98)

A new Flutter package project.
This Dart package offers developers a streamlined library of Flutter widgets, useful for displaying information in a row-based layout.
As the baseline widget, there's the `RowItem` widget. It offers a multitude of options:
* **Text information:** Useful when the associated value can be represented with a simple `Text` widget.
* **Boolean information:** Useful when the associated value with a `boolean` value, which can be represented with an icon.
* **Interactive information:** It allows the associated value, in this case a `Text` widget, to be clickable by the user.

This library offers ways to separate this and other interface elements, using the already-implemented `Separator` class:
* **Spacers:** This kind of elements helps to separate UI elements, such as `RowItem` widgets.
* **Dividers:** Helpful when you want to emphasize separation between sections.
* **Empty elements:** Useful when you need to use an 'empty' widget, with `height` & `width` values equal to `0`.

Both kind of widgets (`RowItem` & `Separator`) offer ways to be customizable. For instance, you can use the `style` parameter in the `RowItem` widgets to select a custom text theme.

## Getting Started
This project is a starting point for a Dart [package](https://flutter.io/developing-packages/), a library module containing code that can be shared easily across multiple Flutter or Dart projects.

For help getting started with Flutter, view our [online documentation](https://flutter.io/docs), which offers tutorials, samples, guidance on mobile development, and a full API reference.

## Built with
* [Flutter](https://flutter.io/) - Beatiful native apps in record time.
* [Android Studio](https://developer.android.com/studio/index.html/) - Tools for building apps on every type of Android device.
* [Visual Studio Code](https://code.visualstudio.com/) - Code editing. Redefined.

This project is a starting point for a Dart
[package](https://flutter.io/developing-packages/),
a library module containing code that can be shared easily across
multiple Flutter or Dart projects.
## Authors
* **Jesús Rodríguez** - you can find me on [GitHub](https://github.com/jesusrp98), [Twitter](https://twitter.com/jesusrp98) & [Reddit](https://www.reddit.com/user/jesusrp98).

For help getting started with Flutter, view our
[online documentation](https://flutter.io/docs), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
## License
This project is licensed under the GNU GPL v3 License - see the [LICENSE.md](LICENSE.md) file for details.

0 comments on commit 9d688a7

Please sign in to comment.