Skip to content

Commit 95110f2

Browse files
committed
ReadMe Creation #3
*Create scale resize AppBar demo. *Create supporter badges. *Revise grammar.
1 parent 4edbf62 commit 95110f2

File tree

5 files changed

+43
-14
lines changed

5 files changed

+43
-14
lines changed

README.md

Lines changed: 43 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
![Screenshots](packages/Responsive%20Cover.png)
22
# Responsive Framework
3-
[![Pub release](https://img.shields.io/badge/flutter-responsive-brightgreen.svg?style=flat-square)](https://github.com/Codelessly/ResponsiveFramework) [![Pub release](https://img.shields.io/pub/v/responsive_framework.svg?style=flat-square)](https://pub.dev/packages/responsive_framework) [![GitHub Release Date](https://img.shields.io/github/release-date/Codelessly/ResponsiveFramework.svg?style=flat-square)](https://github.com/Codelessly/ResponsiveFramework) [![GitHub issues](https://img.shields.io/github/issues/Codelessly/ResponsiveFramework.svg?style=flat-square)](https://github.com/Codelessly/ResponsiveFramework/issues) [![GitHub top language](https://img.shields.io/github/languages/top/Codelessly/ResponsiveFramework.svg?style=flat-square)](https://github.com/Codelessly/ResponsiveFramework) [![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/Codelessly/ResponsiveFramework.svg?style=flat-square)](https://github.com/Codelessly/ResponsiveFramework) [![Libraries.io for GitHub](https://img.shields.io/librariesio/github/Codelessly/ResponsiveFramework.svg?style=flat-square)](https://libraries.io/github/Codelessly/ResponsiveFramework) [![License](https://img.shields.io/badge/License-BSD%200--Clause-orange.svg?style=flat-square)](https://opensource.org/licenses/0BSD)
3+
[![Flutter Responsive](https://img.shields.io/badge/flutter-responsive-brightgreen.svg?style=flat-square)](https://github.com/Codelessly/ResponsiveFramework) [![Pub release](https://img.shields.io/pub/v/responsive_framework.svg?style=flat-square)](https://pub.dev/packages/responsive_framework) [![GitHub Release Date](https://img.shields.io/github/release-date/Codelessly/ResponsiveFramework.svg?style=flat-square)](https://github.com/Codelessly/ResponsiveFramework) [![GitHub issues](https://img.shields.io/github/issues/Codelessly/ResponsiveFramework.svg?style=flat-square)](https://github.com/Codelessly/ResponsiveFramework/issues) [![GitHub top language](https://img.shields.io/github/languages/top/Codelessly/ResponsiveFramework.svg?style=flat-square)](https://github.com/Codelessly/ResponsiveFramework) [![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/Codelessly/ResponsiveFramework.svg?style=flat-square)](https://github.com/Codelessly/ResponsiveFramework) [![Libraries.io for GitHub](https://img.shields.io/librariesio/github/Codelessly/ResponsiveFramework.svg?style=flat-square)](https://libraries.io/github/Codelessly/ResponsiveFramework) [![License](https://img.shields.io/badge/License-BSD%200--Clause-orange.svg?style=flat-square)](https://opensource.org/licenses/0BSD)
44

55
![Screenshots](packages/Responsive%20Demo.gif)
66

@@ -63,14 +63,14 @@ That's it!
6363

6464
![Screenshots](packages/Scale%20Resize%20Comparison.gif)
6565

66-
AutoScale shrinks or expands your layout *proportionally*, keeping every element the same.
66+
AutoScale shrinks and expands your layout *proportionally*, preserving the exact look of your UI.
6767
This eliminates the need to manually adapt layouts to mobile, tablet, and desktop.
6868

6969
```dart
7070
ResponsiveBreakpoint(breakpoint: 600, autoScale: true);
7171
```
7272

73-
Flutter's default behavior is resize so AutoScale is `false` and off by default.
73+
Flutter's default behavior is resize which Responsive Framework respects. AutoScale is off by default and can be enabled at breakpoints by setting `autoScale` to `true`.
7474

7575
## Breakpoints
7676

@@ -96,11 +96,12 @@ These concepts helps you start using the Responsive Framework and build an respo
9696

9797
### Scale vs Resize
9898

99-
Flutter's default behavior is to resize your layout when the screen dimensions change. Resizing a layout stretches it in the unbounded width or height direction. Any fixed or bounded dimension stays the same which is why a mobile app's UI looks small on a desktop.
99+
Flutter's default behavior is to resize your layout when the screen dimensions change. Resizing a layout stretches it in the direction of an unconstrained width or height. Any constrained dimension stays fixed which is why mobile app UIs look tiny on desktop. The following example illustrates the difference between resizing and scaling.
100+
101+
![Screenshots](packages/AppBar%20Scale%20vs%20Resize%20Comparison.png)
100102

101-
To understand the difference between resizing and scaling, take the following example.
102103
An AppBar widget looks correct on a phone. When viewed on a desktop however, the AppBar is too short and the title looks too small.
103-
Here is what happens with each behavior:
104+
Here is what happens under each behavior:
104105
1. Resizing (default) - the AppBar's width is double.infinity so it stretches to fill the available width. The Toolbar height is fixed and stays 56dp.
105106
2. Scaling - the AppBar's width stretches to fill the available width. The height scales proportionally using an aspect ratio automatically calculated from the nearest `ResponsiveBreakpoint`. As the width increases, the height increases proportionally.
106107

@@ -127,20 +128,48 @@ ResponsiveWrapper(
127128
```
128129

129130
An arbitrary number of breakpoints can be set. Resizing/scaling behavior can be mixed and matched.
130-
- below 450: resize on small screens to avoid cramp and overflow errors.
131-
- 800-450: resize on phones for native widget sizes.
132-
- 1000-800: scale on tablets to avoid elements appearing too small.
133-
- 1200-1000: resize on desktops to use available space.
134-
- 2460+: scale on extra large 4K displays so text is still legible and widgets are not spaced too far apart.
131+
- below 450: resize on small screens to avoid cramp and overflow errors.
132+
- 800-450: resize on phones for native widget sizes.
133+
- 1000-800: scale on tablets to avoid elements appearing too small.
134+
- 1200-1000: resize on desktops to use available space.
135+
- 2460+: scale on extra large 4K displays so text is still legible and widgets are not spaced too far apart.
135136

136137
## About
137138

138-
Responsive Framework was created to provide a better way for people to build responsive apps and websites. The ability to automatically adapt UI to different sizes opens up a world of new possibilities. Here at Codelessly, we're working on #NoCode and code generation automation tools to make those possibilities happen. If you are thinking about building a website builder, drop us a line below 😎
139+
Responsive Framework was created out of a desire for a better way to manage responsiveness. The ability to automatically adapt UI to different sizes opens up a world of possibilities. Here at Codelessly, we're working on #NoCode and code generation automation tools to increase productivity. If you are interested in building a website builder powered by computer vision, drop us a line below 😎
139140

140-
Responsive Framework is licensed under Zero-Clause BSD and released as Emailware. If you like this project or it helped you, please subscribe to updates. Although it is not required, you might miss some important information!
141+
Responsive Framework is licensed under Zero-Clause BSD and released as Emailware. If you like this project or it helped you, please subscribe to updates. Although it is not required, you might miss the goodies we share!
141142

142143
<a href="https://codelessly.com" target="_blank"><img src="packages/Email%20Newsletter%20Signup.png"></a>
143144

145+
## Badges 🏆
146+
147+
Now you can proudly display the time and headache saved by using Responsive Framework with a supporter's badge.
148+
149+
[![Pub release](https://img.shields.io/badge/flutter-responsive-brightgreen.svg?style=flat-square)](https://github.com/Codelessly/ResponsiveFramework)
150+
151+
```
152+
[![Flutter Responsive](https://img.shields.io/badge/flutter-responsive-brightgreen.svg?style=flat-square)](https://github.com/Codelessly/ResponsiveFramework)
153+
```
154+
155+
<img alt="Built Responsive" src="packages/Built%20Responsive%20Badge.png"/>
156+
157+
```html
158+
<a href="https://github.com/Codelessly/ResponsiveFramework">
159+
<img alt="Built Responsive"
160+
src="https://raw.githubusercontent.com/Codelessly/ResponsiveFramework/master/packages/Built%20Responsive%20Badge.png"/>
161+
</a>
162+
```
163+
164+
<img alt="Built with Responsive Framework" src="packages/Built%20with%20Responsive%20Badge.png"/>
165+
166+
```html
167+
<a href="https://github.com/Codelessly/ResponsiveFramework">
168+
<img alt="Built with Responsive Framework"
169+
src="https://raw.githubusercontent.com/Codelessly/ResponsiveFramework/master/packages/Built%20with%20Responsive%20Badge.png"/>
170+
</a>
171+
```
172+
144173
## Contributors ❤️
145174

146175
**Design:**
@@ -170,7 +199,7 @@ Responsive Framework is licensed under Zero-Clause BSD and released as Emailware
170199
</a>
171200
<br></br>
172201

173-
Flutter is a game-changing technology that will revolutionize not just development, but software itself. A big thank you to the Flutter team for building such an amazing platform and being giants we can stand on.
202+
Flutter is a game-changing technology that will revolutionize not just development, but software itself. A big thank you to the Flutter team for building such an amazing platform 💙
174203

175204
<a href="https://github.com/flutter/flutter">
176205
<img alt="Flutter"
18 KB
Loading
4.92 KB
Loading
4.33 KB
Loading

packages/Responsive Logo.png

12.6 KB
Loading

0 commit comments

Comments
 (0)