Skip to content

Commit 30c95f8

Browse files
authored
Update README.md
1 parent 8cbd1ee commit 30c95f8

File tree

1 file changed

+11
-30
lines changed

1 file changed

+11
-30
lines changed

README.md

Lines changed: 11 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,20 @@
1-
<!--
2-
This README describes the package. If you publish this package to pub.dev,
3-
this README's contents appear on the landing page for your package.
1+
[![Dart](https://github.com/zinigor/dart_comfy_frontend/actions/workflows/dart.yml/badge.svg)](https://github.com/zinigor/dart_comfy_frontend/actions/workflows/dart.yml)
42

5-
For information about how to write a good package README, see the guide for
6-
[writing package pages](https://dart.dev/tools/pub/writing-package-pages).
7-
8-
For general information about developing packages, see the Dart guide for
9-
[creating packages](https://dart.dev/guides/libraries/create-packages)
10-
and the Flutter guide for
11-
[developing packages and plugins](https://flutter.dev/to/develop-packages).
12-
-->
13-
14-
TODO: Put a short description of the package here that helps potential users
15-
know whether this package might be useful for them.
3+
A Dart package for managing ComfyUI workflow files.
164

175
## Features
186

19-
TODO: List what your package can do. Maybe include images, gifs, or videos.
20-
21-
## Getting started
22-
23-
TODO: List prerequisites and provide or point to information on how to
24-
start using the package.
7+
- [x] Load Workflow JSON files into a class to be used in an application state.
8+
- [ ] Make sure Workflow JSON is properly validated.
9+
- [ ] Add a simple Workflow view.
10+
- [ ] Add a simple state using ChangeNotifier.
11+
- [ ] Figure out a way to upload files to the single page application.
2512

2613
## Usage
2714

28-
TODO: Include short and useful examples for package users. Add longer examples
29-
to `/example` folder.
15+
Add this to your pubspec.yaml file:
3016

31-
```dart
32-
const like = 'sample';
17+
```yaml
18+
dart_comfy_frontend:
19+
git: https://github.com/zinigor/dart_comfy_frontend.git
3320
```
34-
35-
## Additional information
36-
37-
TODO: Tell users more about the package: where to find more information, how to
38-
contribute to the package, how to file issues, what response they can expect
39-
from the package authors, and more.

0 commit comments

Comments
 (0)