Skip to content

Commit 84b3e38

Browse files
committed
improve README.md
1 parent 2f45927 commit 84b3e38

File tree

2 files changed

+29
-8
lines changed

2 files changed

+29
-8
lines changed

README.md

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
1-
# flet-charts
1+
# flet-datatable2
22

3-
[![pypi](https://img.shields.io/pypi/v/flet-charts.svg)](https://pypi.python.org/pypi/flet-charts)
4-
[![downloads](https://static.pepy.tech/badge/flet-charts/month)](https://pepy.tech/project/flet-charts)
5-
[![license](https://img.shields.io/github/license/flet-dev/flet-charts.svg)](https://github.com/flet-dev/flet-charts/blob/main/LICENSE)
3+
[![pypi](https://img.shields.io/pypi/v/flet-datatable2.svg)](https://pypi.python.org/pypi/flet-datatable2)
4+
[![downloads](https://static.pepy.tech/badge/flet-datatable2/month)](https://pepy.tech/project/flet-datatable2)
5+
[![license](https://img.shields.io/github/license/flet-dev/flet-datatable2.svg)](https://github.com/flet-dev/flet-datatable2/blob/main/LICENSE)
66

7-
A Flet extension for creating interactive charts and graphs.
7+
An enhanced data table for [Flet](https://flet.dev) apps that builds on the built-in component by adding sticky headers,
8+
fixed top rows, and fixed left columns while preserving all core features.
89

9-
It is based on the [charts](https://pub.dev/packages/fl_chart) Flutter package.
10+
It is based on [data_table_2](https://pub.dev/packages/data_table_2) Flutter package.
1011

1112
## Documentation
1213

13-
You can find its documentation [here](https://flet-dev.github.io/flet-charts).
14+
You can find its documentation [here](https://flet-dev.github.io/flet-datatable2).
1415

1516
## Platform Support
1617

@@ -24,3 +25,23 @@ This package supports the following platforms:
2425
| iOS ||
2526
| Android ||
2627
| Web ||
28+
29+
## Installation
30+
31+
To install the `flet-datatable2` package and add it to your project dependencies:
32+
33+
- Using `uv`:
34+
```bash
35+
uv add flet-datatable2
36+
```
37+
38+
- Using `pip`:
39+
```bash
40+
pip install flet-datatable2
41+
```
42+
After this, you will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
43+
44+
- Using `poetry`:
45+
```bash
46+
poetry add flet-datatable2
47+
```

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-datatable2/month)](https://pepy.tech/project/flet-datatable2)
55
[![license](https://img.shields.io/github/license/flet-dev/flet-datatable2.svg)](https://github.com/flet-dev/flet-datatable2/blob/main/LICENSE)
66

7-
An enhanced DataTable for Flet apps that builds on the built-in component by adding sticky headers,
7+
An enhanced data table for [Flet](https://flet.dev) apps that builds on the built-in component by adding sticky headers,
88
fixed top rows, and fixed left columns while preserving all core features.
99

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

0 commit comments

Comments
 (0)