Skip to content
This repository was archived by the owner on Dec 24, 2025. It is now read-only.

Commit 675d17e

Browse files
committed
improve README.md
1 parent 08c52c0 commit 675d17e

2 files changed

Lines changed: 38 additions & 17 deletions

File tree

README.md

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,46 @@
1-
# Flashlight control for Flet
1+
# flet-flashlight
22

3-
`Flashlight` control for Flet.
3+
[![pypi](https://img.shields.io/pypi/v/flet-flashlight.svg)](https://pypi.python.org/pypi/flet-flashlight)
4+
[![downloads](https://static.pepy.tech/badge/flet-flashlight/month)](https://pepy.tech/project/flet-flashlight)
5+
[![license](https://img.shields.io/github/license/flet-dev/flet-flashlight.svg)](https://github.com/flet-dev/flet-flashlight/blob/main/LICENSE)
46

5-
## Usage
7+
A [Flet](https://flet.dev) extension to manage the device torch/flashlight.
68

7-
Add `flet-flashlight` as dependency (`pyproject.toml` or `requirements.txt`) to your Flet project.
9+
It is based on the [flashlight](https://pub.dev/packages/flashlight) Flutter package.
810

9-
## Example
11+
## Documentation
1012

11-
```py
13+
Detailed documentation to this package can be found [here](https://flet-dev.github.io/flet-flashlight/).
1214

13-
import flet as ft
15+
## Platform Support
1416

15-
import flet_flashlight as ffl
17+
This package supports the following platforms:
1618

17-
def main(page: ft.Page):
18-
flashlight = ffl.Flashlight()
19-
page.overlay.append(flashlight)
20-
page.add(
21-
ft.TextButton("toggle", on_click=lambda _: flashlight.toggle())
22-
)
19+
| Platform | Supported |
20+
|----------|:---------:|
21+
| Windows ||
22+
| macOS ||
23+
| Linux ||
24+
| iOS ||
25+
| Android ||
26+
| Web ||
2327

24-
ft.app(main)
25-
```
28+
## Installation
29+
30+
To install the `flet-flashlight` package and add it to your project dependencies:
31+
32+
- Using `uv`:
33+
```bash
34+
uv add flet-flashlight
35+
```
36+
37+
- Using `pip`:
38+
```bash
39+
pip install flet-flashlight
40+
```
41+
After this, you will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
42+
43+
- Using `poetry`:
44+
```bash
45+
poetry add flet-flashlight
46+
```

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![downloads](https://static.pepy.tech/badge/flet-flashlight/month)](https://pepy.tech/project/flet-flashlight)
55
[![license](https://img.shields.io/github/license/flet-dev/flet-flashlight.svg)](https://github.com/flet-dev/flet-flashlight/blob/main/LICENSE)
66

7-
A Flet extension to manage the device torch/flashlight.
7+
A [Flet](https://flet.dev) extension to manage the device torch/flashlight.
88

99
It is based on the [flashlight](https://pub.dev/packages/flashlight) Flutter package.
1010

0 commit comments

Comments
 (0)