-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add README first paragraphs. #1
- Loading branch information
1 parent
94852ba
commit 68b1c9f
Showing
1 changed file
with
52 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,54 @@ | ||
# flutter-navigation-menu-demo | ||
A quick demo of building a navigation menu in Flutter to illustrate the functionality in isolation. | ||
|
||
<div align="center"> | ||
|
||
# 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) | ||
|
||
|
||
</div> | ||
|
||
<br /> | ||
|
||
# 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`. | ||
|