Skip to content

Commit

Permalink
update readme and documentation
Browse files Browse the repository at this point in the history
get ready for v0.1.0 release
  • Loading branch information
immadisairaj committed Jul 5, 2022
1 parent c6e4365 commit 15e923e
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 5 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
## 0.1.0
- Update README
- Update Documentation

## 0.0.1
- Initial Release
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
A digital LCD display for numbers.
An automatic sizer digital single-digit number with LCD style widget.

<img width="1004" alt="Screenshot 2022-07-05 at 21 59 40" src="https://user-images.githubusercontent.com/40348358/177374481-a1ad589f-dde3-44f1-828e-8fb2dd23a2ab.png">

<!-- ## Features -->
## Features

This package (or widget) can be used across any platform as it is platform independent

- Customize the colors of the widget

## Setup

There is no special setup required, just add the dependency in `pubspec.yaml`, import the file, and you are good to go..

Add the dependency in `pubspec.yaml`
```yaml
digital_lcd_number: ^0.0.1 # Note: use latest version
digital_lcd_number: ^0.1.0 # Note: use latest version
```
Import the widget into dart file
Expand All @@ -21,6 +25,7 @@ import 'package:digital_lcd_number/digital_lcd_number.dart';
## Usage

```dart
// default usage
DigitalLcdNumber(number: 0),
```

Expand Down
2 changes: 2 additions & 0 deletions lib/src/lcd_component.dart
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,12 @@ class DigitalLcdNumber extends StatelessWidget {
final int number;

/// the color of the LCD display. (optional)
///
/// If not provided, it will default to primary color of the theme.
final Color? color;

/// disabled color of the LCD display. (optional)
///
/// If not provided, it will be set to [color] with an alpha value of 10%.
final Color? disabledColor;

Expand Down
4 changes: 2 additions & 2 deletions pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: digital_lcd_number
description: A digital LCD display for numbers.
version: 0.0.1
description: An automatic sizer digital single-digit number with LCD style widget.
version: 0.1.0
# homepage:
repository: https://github.com/immadisairaj/digital_lcd_number

Expand Down

0 comments on commit 15e923e

Please sign in to comment.