From b4888de5558ff9e9ad5bc2f103bbacd8e59bc003 Mon Sep 17 00:00:00 2001 From: Aditya Thakur <53579386+adityathakurxd@users.noreply.github.com> Date: Sun, 25 Jul 2021 16:24:05 +0530 Subject: [PATCH] Update README.md --- README.md | 71 +++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 59 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 9546b54..2a19b69 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,64 @@ -# fancy_containers -Fancy Containers Flutter Package to add a fancy container to your Flutter App. +# Fancy Containers -## Getting Started +Fancy container package lets you add a beautiful gradient container to your Flutter app. -Add the dependency to your Flutter App. -Import the package and use in your Flutter App. +## Installation -This project is a starting point for a Dart -[package](https://flutter.dev/developing-packages/), -a library module containing code that can be shared easily across -multiple Flutter or Dart projects. +1. Add the latest version of package to your pubspec.yaml (and run`dart pub get`): +```yaml +dependencies: + fancy_containers: ^0.0.1 +``` +2. Import the package and use it in your Flutter App. +```dart +import 'package:fancy_containers/fancy_containers.dart'; +``` -For help getting started with Flutter, view our -[online documentation](https://flutter.dev/docs), which offers tutorials, -samples, guidance on mobile development, and a full API reference. +## Example +There are a number of properties that you can modify: + + - height + - width + - title + - subtitle + - gradient (color1 and color2) + +
+ + + + + + +
+ +```dart +class FancyScreen extends StatelessWidget { + const FancyScreen({Key? key}) : super(key: key); + + @override + Widget build(BuildContext context) { + return Scaffold( + body: Center( + child: const FancyContainer( + title: 'Hello World', + color1: Colors.lightGreenAccent, + color2: Colors.lightBlue, + subtitle: 'This is a new package', + ), + ), + ); + } +} +``` + + + +
+ +## Next Goals + + - [ ] Add onTap for functions. + - [ ] Change font and color style for text. + - [ ] Add more containers to the package.