Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
alexmercerind committed Sep 5, 2023
1 parent b3e6406 commit c2e47b8
Showing 1 changed file with 37 additions and 24 deletions.
61 changes: 37 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,39 @@
<h1 align="center"><a href="https://github.com/alexmercerind/windows_taskbar">windows_taskbar</a></h1>
<p align="center">Flutter plugin serving utilities related to Windows taskbar.</p>
# [windows_taskbar](https://github.com/alexmercerind/windows_taskbar)

## Install
#### Flutter plugin serving utilities related to Windows taskbar.

## Installation

Add package to the dependencies section of the `pubspec.yaml`:

```yaml
dependencies:
windows_taskbar: ^1.1.1
windows_taskbar: ^1.1.2
```
<table>
<tr>
<td>
<img width="713" height="auto" src="https://user-images.githubusercontent.com/28951144/205107667-c3db0382-a5fa-456d-af01-7c5ab9c94ceb.gif">
</td>
</tr>
<tr>
<td>
<img width="713" height="auto" src="https://user-images.githubusercontent.com/28951144/205107645-9732aabe-0e39-42c7-87d3-bbd2bca82fa6.gif">
</td>
</tr>
</table>
<br></br>
<img width="600" height="auto" src="https://user-images.githubusercontent.com/28951144/205107667-c3db0382-a5fa-456d-af01-7c5ab9c94ceb.gif">
<img width="600" height="auto" src="https://user-images.githubusercontent.com/28951144/205107645-9732aabe-0e39-42c7-87d3-bbd2bca82fa6.gif">
Checkout the example Flutter application [here](https://github.com/alexmercerind/windows_taskbar/blob/master/example/lib/main.dart).
## Guide
## Docs
A minimal usage guide for [package:windows_taskbar](https://github.com/alexmercerind/windows_taskbar).
### Contents
- [Set thumbnail toolbar](#set-thumbnail-toolbar)
- [Remove thumbnail toolbar](#remove-thumbnail-toolbar)
- [Set progress mode](#set-progress-mode)
- [Set progress](#set-progress)
- [Set thumbnail tooltip](#set-thumbnail-tooltip)
- [Flash windows taskbar app icon](#flash-windows-taskbar-app-icon)
- [Stop flashing windows taskbar app icon](#stop-flashing-windows-taskbar-app-icon)
- [Set overlay icon (badge)](#set-overlay-icon-badge)
- [Remove overlay icon (badge)](#remove-overlay-icon-badge)
- [Set window title (taskbar button label)](#set-window-title-taskbar-button-label)
- [Reset window title (or taskbar button label)](#reset-window-title-taskbar-button-label)
- [Next steps](#next-steps)
#### Set thumbnail toolbar
Expand Down Expand Up @@ -89,7 +99,7 @@ WindowsTaskbar.setFlashTaskbarAppIcon(
WindowsTaskbar.resetFlashTaskbarAppIcon();
```

#### Set overlay icon (a badge)
#### Set overlay icon (badge)

```dart
WindowsTaskbar.setOverlayIcon(
Expand All @@ -98,25 +108,28 @@ WindowsTaskbar.setOverlayIcon(
);
```

#### Remove overlay icon (a badge)
#### Remove overlay icon (badge)

```dart
WindowsTaskbar.resetOverlayIcon();
```

#### Set window title (or taskbar button label)
#### Set window title (taskbar button label)

```dart
WindowsTaskbar.setWindowTitle('Never Gonna Give You Up');
```

#### Reset window title (or taskbar button label)
#### Reset window title (taskbar button label)

```dart
WindowsTaskbar.resetWindowTitle();
```

Please see [API reference](https://pub.dev/documentation/windows_taskbar/latest/windows_taskbar/windows_taskbar-library.html) for extended information & more detail about various configurations.
#### Next steps

- [API reference](https://pub.dev/documentation/windows_taskbar/latest/windows_taskbar/windows_taskbar-library.html) can be helpful for diving into deeper specifics.
- [Source-code of the example application](https://github.com/alexmercerind/windows_taskbar/blob/master/example/lib/main.dart) offers some complete code samples.

## Sponsor

Expand All @@ -129,4 +142,4 @@ You may consider buying me a coffee if you like this package.

Copyright © 2021 & onwards, Hitesh Kumar Saini <<[email protected]>>

This library & all the work in this repository is under MIT license that can be found in the LICENSE file.
This project & the work under this repository is governed by MIT license that can be found in the [LICENSE](https://github.com/alexmercerind/windows_taskbar/blob/master/LICENSE) file.

0 comments on commit c2e47b8

Please sign in to comment.