Skip to content

Commit 5273a94

Browse files
author
Chahat Gupta
committed
Updated readme, changelog, pubspec and added example
1 parent 92a307d commit 5273a94

File tree

4 files changed

+41
-3
lines changed

4 files changed

+41
-3
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
## 1.0.3
2+
3+
- Added support for audio files (.mp3 and .wav)
4+
- Optimized sorting and copy path functionality
5+
16
## 1.0.2
27

38
- Made search bar sticky

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Asset Showcase is a Dart package that generates an HTML showcase for assets pres
66

77
- Generates an HTML showcase for assets in a specified directory.
88
- Supports sorting assets by name or size.
9+
- Supports filtering assets based on file extensions.
910
- Includes a search bar for quickly finding assets.
10-
- Displays file type indicators for different asset types.
1111
- Provides a responsive and interactive user interface.
1212
- Easy to customize and integrate into your projects.
1313

@@ -20,7 +20,7 @@ To use Asset Showcase in your Dart project, add it as a dev dependency in your `
2020

2121
```yaml
2222
dev_dependencies:
23-
asset_showcase: ^1.0.2
23+
asset_showcase: ^1.0.3
2424
```
2525
2626
Then, run `dart pub get` or `flutter pub get` to install the package.

example/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## Installation
2+
3+
To use Asset Showcase in your Dart project, add it as a dev dependency in your `pubspec.yaml` file:
4+
5+
```yaml
6+
dev_dependencies:
7+
asset_showcase: ^1.0.3
8+
```
9+
10+
Then, run `dart pub get` or `flutter pub get` to install the package.
11+
12+
## Usage
13+
14+
Once installed, you can use Asset Showcase to generate an HTML showcase for your assets. Just run it like any Dart package:
15+
16+
```bash
17+
dart run asset_showcase
18+
```
19+
20+
This will generate a showcase HTML file named `showcase.html` in the root directory of your project, showcasing assets from the `assets` directory.
21+
22+
## Command-line Options
23+
24+
Asset Showcase supports the following command-line options:
25+
26+
- `--assets`: Specifies the directory containing assets. Defaults to `'assets'`.
27+
- `--output`: Specifies the output HTML file path. Defaults to `'showcase.html'`.
28+
29+
You can pass these options when running the Dart script, like so:
30+
31+
```bash
32+
dart run asset_showcase --assets=path/to/assets --output=path/to/output.html
33+
```

pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: asset_showcase
22
description: A dart package to help you visually list and analyze your Flutter project assets
3-
version: 1.0.2
3+
version: 1.0.3
44
repository: https://github.com/chtgupta/flutter-asset-showcase
55

66
environment:

0 commit comments

Comments
 (0)