Skip to content

Commit 5bc0c4a

Browse files
authored
doc(readme): minor corrections
1 parent 8e0fde7 commit 5bc0c4a

File tree

1 file changed

+10
-13
lines changed

1 file changed

+10
-13
lines changed

README.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,20 @@ Rultor.com](https://www.rultor.com/b/dartoos-dev/flutter_brand_palettes)](https:
1414
[![build](https://github.com/dartoos-dev/flutter_brand_palettes/actions/workflows/build.yml/badge.svg)](https://github.com/dartoos-dev/flutter_brand_palettes/actions/)
1515
[![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)
1616
![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)
1817
[![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)
18+
[![style: lint](https://img.shields.io/badge/style-lint-4BC0F5.svg)](https://pub.dev/packages/lint)
1919

2020
## Overview
2121

2222
**Flutter Brand Palettes** is a collection of declarative and object-oriented
2323
classes for the color palettes of popular brands and companies.
2424

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
25+
For example, to get Instagram colors as a `List<Color>`object,
26+
simply declare `InstagramGrad().colors` — the 'Grad' suffix is short for
2727
_Gradient_.
2828

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.
29+
To get a single color: `Instagram.royalBlue().color`, for Instagram
30+
royal blue;`Instagram.yellow().color`, for Instagram yellow.
3231

3332
In addition, each class is well-documented and fully unit-tested — this package
3433
has achieved 100% code coverage and goes through a CI pipeline with rigorous
@@ -116,17 +115,15 @@ This should launch the demo application on Chrome in debug mode.
116115

117116
Do you need any brand that has not yet been implemented?
118117

119-
- Just open an
120-
[issue](https://github.com/dartoos-dev/flutter_brand_palettes/issues), enter
121-
the brand or company name, and the brand colors will be implemented as soon as
122-
possible.
118+
It doesn't matter the size and relevance of the company, not even if it's a
119+
tech company.
123120

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

127124
## List of Color Palettes (A-Z)
128125

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

0 commit comments

Comments
 (0)