From 68b1c9fdeb4e38947060ebd283ab5fb763bdb624 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lui=CC=81s=20Arteiro?= Date: Tue, 14 Feb 2023 14:22:07 +0000 Subject: [PATCH] feat: Add README first paragraphs. #1 --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/README.md b/README.md index 5ef4327..cb0a06c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,54 @@ # flutter-navigation-menu-demo A quick demo of building a navigation menu in Flutter to illustrate the functionality in isolation. + +
+ +# Navigation Menu in `Flutter` Demo + +A simple showcase of +building a navigation menu in `Flutter`. + +![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/dwyl/flutter-navigation-menu-demo/ci.yml?label=build&style=flat-square&branch=main) +[![HitCount](https://hits.dwyl.com/dwyl/flutter-navigation-menu-demo.svg?style=flat-square&show=unique)](http://hits.dwyl.com/dwyl/flutter-navigation-menu-demo) +[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat-square)](https://github.com/dwyl/flutter-navigation-menu-demo/issues) + + +
+ +
+ +# Why? 🤷‍ + +This small demo is meant for *anyone* +who wants to see a quick implementation +of [**progressive UX/UI**](https://github.com/dwyl/product-roadmap/issues/43). + +# What? 💭 + +We want to add an easy onboarding experience +for users when they start using our +[`app`](https://github.com/dwyl/app). + +As we are using `Flutter` to develop our app, +this demo will focus on a `Dart` implementation of this, +focussing on the navigation menu component. + + +# Who? 👤 + +This quick demo is aimed at people in the @dwyl team +who need to understand how to create +a basic app navigation that is *progressive*. + +# _How_? 👩‍💻 + +## Prerequisites? 📝 + +This `demo` assumes you have foundational knowledge +of `Flutter`. + +If this is your first time using `Flutter`, +we highly suggest you check out +[`dwyl/learn-flutter`](https://github.com/dwyl/learn-flutter) +for a *primer* on how to get up-and-running with `Flutter`. +