Skip to content

Commit 546990c

Browse files
update:update README file
1 parent bd58d0c commit 546990c

File tree

3 files changed

+43
-10
lines changed

3 files changed

+43
-10
lines changed

README.md

Lines changed: 42 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,49 @@
11
# flutter_easy_flow
22

3-
A new Flutter project.
3+
`flutter_easy_flow` is a Flutter project designed to simplify the process of creating and managing flow diagrams.
44

5-
## Getting Started
5+
## 🚀 Features Showcase
66

7-
This project is a starting point for a Flutter application.
7+
Here are some of the key features of `flutter_easy_flow` in action:
88

9-
A few resources to get you started if this is your first Flutter project:
9+
- **Node Management**: Easily add, delete, and modify nodes to create detailed flow diagrams.
10+
- **Group Nodes**: Efficiently manage complex diagrams by grouping nodes.
11+
- **Real-time Data Rendering**: Automatically render flow diagrams based on real-time data.
12+
- **Real-time Data Viewing**: View the underlying data of flow diagrams in real-time.
1013

11-
- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
12-
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
14+
![Screen Recording](screen_recording.gif)
15+
16+
## 🛠️ Installation
17+
18+
To get started with `flutter_easy_flow`, follow these steps:
19+
20+
1. Clone the repository:
21+
```bash
22+
git clone https://github.com/yourusername/flutter_easy_flow.git
23+
```
24+
2. Navigate to the project directory:
25+
```bash
26+
cd flutter_easy_flow
27+
```
28+
3. Install dependencies:
29+
```bash
30+
flutter pub get
31+
```
32+
4. Run the app:
33+
```bash
34+
flutter run
35+
```
36+
37+
### 🤝 Contributing
38+
39+
Welcome contributions from the community. If you would like to contribute, please follow these steps:
40+
41+
1. Fork the repository.
42+
2. Create a new branch for your feature or bugfix.
43+
3. Commit your changes and push the branch to your fork.
44+
4. Create a pull request with a detailed description of your changes.
45+
46+
### 📄 License
47+
48+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
1349

14-
For help getting started with Flutter development, view the
15-
[online documentation](https://docs.flutter.dev/), which offers tutorials,
16-
samples, guidance on mobile development, and a full API reference.

lib/flow_chart/objects/task_widget.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ class TaskWidget extends StatelessWidget {
103103
),
104104
SizedBox(height: 2 * element.zoom),
105105
Text(
106-
element.id.substring(0, 5),
106+
element.subTitleText,
107107
style: subtitleTextStyle,
108108
)
109109
],

screen_recording.gif

1.49 MB
Loading

0 commit comments

Comments
 (0)