Skip to content

Commit c68e36b

Browse files
authored
doc(readme): fix typos and add minor improvements (#92)
1 parent f0b440f commit c68e36b

File tree

6 files changed

+55
-13
lines changed

6 files changed

+55
-13
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
### Changed
11+
12+
- bump up eo_color dependency —
13+
[90](https://github.com/dartoos-dev/flutter_brand_palettes/issues/90).
14+
- fix types and add minor improvements to README —
15+
[89](https://github.com/dartoos-dev/flutter_brand_palettes/issues/89).
16+
1017
## [0.3.6] - 2021-06-26
1118

1219
### Added

README.md

Lines changed: 43 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,38 @@ Rultor.com](https://www.rultor.com/b/dartoos-dev/flutter_brand_palettes)](https:
99

1010
[![pub](https://img.shields.io/pub/v/flutter_brand_palettes)](https://pub.dev/packages/flutter_brand_palettes)
1111
[![license](https://img.shields.io/badge/license-mit-green.svg)](https://github.com/dartoos-dev/flutter_brand_palettes/blob/master/LICENSE)
12-
[![style:
13-
lint](https://img.shields.io/badge/style-lint-4BC0F5.svg)](https://pub.dev/packages/lint)
14-
[![PDD
15-
status](https://www.0pdd.com/svg?name=dartoos-dev/flutter_brand_palettes)](https://www.0pdd.com/p?name=dartoos-dev/flutter_brand_palettes)
12+
[![PDD status](https://www.0pdd.com/svg?name=dartoos-dev/flutter_brand_palettes)](https://www.0pdd.com/p?name=dartoos-dev/flutter_brand_palettes)
13+
1614
[![build](https://github.com/dartoos-dev/flutter_brand_palettes/actions/workflows/build.yml/badge.svg)](https://github.com/dartoos-dev/flutter_brand_palettes/actions/)
1715
[![codecov](https://codecov.io/gh/dartoos-dev/flutter_brand_palettes/branch/master/graph/badge.svg?token=Hvpu48mfx1)](https://codecov.io/gh/dartoos-dev/flutter_brand_palettes)
1816
![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/rafamizes/flutter_brand_palettes)
17+
[![style: lint](https://img.shields.io/badge/style-lint-4BC0F5.svg)](https://pub.dev/packages/lint)
1918
[![Hits-of-Code](https://hitsofcode.com/github/dartoos-dev/flutter_brand_palettes?branch=master)](https://hitsofcode.com/github/dartoos-dev/flutter_brand_palettes/view?branch=master)
2019

2120
## Overview
2221

2322
**Flutter Brand Palettes** is a collection of declarative and object-oriented
2423
classes for the color palettes of popular brands and companies.
2524

26-
In addition, this package is fully tested — 100% code coverage —, well
27-
documented, and goes through a CI pipeline with rigorous quality gates.
25+
For example, to get all the Instagram's colors at once as a `List<Color>`
26+
object, simply declare `InstagramGrad.colors` — the 'Grad' suffix is short for
27+
_Gradient_.
28+
29+
To get a single color, you just state which of the brand's colors you want. E.g.
30+
`Instagram.royalBlue` retrieves the Instagram's royal blue color;
31+
`Instagram.yellow`, the Instagram's yellow color; and so on.
32+
33+
In addition, each class is well-documented and fully unit-tested — this package
34+
has achieved 100% code coverage and goes through a CI pipeline with rigorous
35+
quality gates.
2836

2937
## Contents
3038

3139
- [Overview](#overview)
3240
- [Getting Started](#getting-started)
3341
- [Color Palettes in action](#color-palettes-in-action)
42+
- [Color Gradient in action](#color-gradient-in-action)
43+
- [Color Gradients](#color-palettes-in-action)
3444
- [Demo application](#demo-application)
3545
- [I need the 'X' color palettes](#i-need-the-x-brand-color-palette)
3646
- [List of Color Palettes](#list-of-color-palettes-a-z)
@@ -62,6 +72,27 @@ class FacebookIsh extends StatelessWidget {
6272
}
6373
```
6474

75+
## Color Gradient in Action
76+
77+
```dart
78+
79+
/// Rectangle filled with Google logo color gradient.
80+
class Googleish extends StatelessWidget {
81+
82+
@override
83+
Widget build(BuildContext context) {
84+
return Container(
85+
height: kToolbarHeight / 2,
86+
decoration: BoxDecoration(
87+
gradient: LinearGradient(
88+
colors: GoogleGrad().colors,
89+
),
90+
),
91+
);
92+
}
93+
94+
```
95+
6596
## Demo application
6697

6798
The demo application provides a fully working example, focused on demonstrating
@@ -87,11 +118,15 @@ Do you need any brand that has not yet been implemented?
87118

88119
- Just open an
89120
[issue](https://github.com/dartoos-dev/flutter_brand_palettes/issues), enter
90-
the brand or company name, and it will be implemented as soon as possible.
121+
the brand or company name, and the brand colors will be implemented as soon as
122+
possible.
123+
124+
**Note:** It doesn't matter the size or relevance of the company, not even if it
125+
is a tech company.
91126

92127
## List of Color Palettes (A-Z)
93128

94-
For more in-depth details — the colors hex codes, classes, etc. —, check the
129+
For more in-depth details — such as the hex codes, classes, etc. —, check the
95130
[color-palettes](https://pub.dev/documentation/flutter_brand_palettes/latest/palettes/palettes-library.html)
96131
API documentation.
97132

example/pubspec.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ packages:
4949
name: eo_color
5050
url: "https://pub.dartlang.org"
5151
source: hosted
52-
version: "1.1.2"
52+
version: "1.1.3"
5353
fake_async:
5454
dependency: transitive
5555
description:
@@ -68,7 +68,7 @@ packages:
6868
path: ".."
6969
relative: true
7070
source: path
71-
version: "0.3.5"
71+
version: "0.3.6"
7272
flutter_test:
7373
dependency: "direct dev"
7474
description: flutter

example/pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ environment:
99
sdk: ">=2.12.0 <3.0.0"
1010

1111
dependencies:
12-
eo_color: ^1.1.2
12+
eo_color: ^1.1.3
1313
flutter:
1414
sdk: flutter
1515

pubspec.lock

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ packages:
4949
name: eo_color
5050
url: "https://pub.dartlang.org"
5151
source: hosted
52-
version: "1.1.2"
52+
version: "1.1.3"
5353
fake_async:
5454
dependency: transitive
5555
description:

pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ environment:
99
flutter: ">=1.17.0"
1010

1111
dependencies:
12-
eo_color: ^1.1.2
12+
eo_color: ^1.1.3
1313
flutter:
1414
sdk: flutter
1515

0 commit comments

Comments
 (0)