Skip to content

Commit 44b42ff

Browse files
committed
readme and changelog
1 parent 9f19689 commit 44b42ff

File tree

2 files changed

+24
-19
lines changed

2 files changed

+24
-19
lines changed

CHANGELOG.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
## [0.0.1] - TODO: Add release date.
1+
# CHANGELOG
22

3-
* TODO: Describe initial release.
3+
See [REleases page on github](https://github.com/renancaraujo/photo_view/releases)

README.md

+22-17
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,11 @@ Resolves a image provider and show the result with useful gestures support, such
1212

1313
Add `photo_view` as a dependency in your pubspec.yaml file.
1414

15-
#### Todo:
16-
- [x] Scale on doubleTap
17-
- [x] Zoom when pinched
18-
- [x] Respect screen and image boundaries
19-
- [x] Center image when zooming out
20-
- [x] Add image zoom limits (`minScale` an `maxScale`)
21-
- [x] Add GIF support
22-
- [ ] Multiple image support (Gallery mode)
23-
- [ ] Rotate gesture rotates image ([Work in progress](https://github.com/renancaraujo/photo_view/pull/4))
15+
Import Photo View:
16+
```dart
17+
import 'package:photo_view/photo_view.dart';
18+
```
2419

25-
Pull requests are welcome 😊.
2620

2721
## Sample code
2822

@@ -33,7 +27,9 @@ Given a `ImageProvider imageProvider` (such as [AssetImage](https://docs.flutter
3327
Widget build(BuildContext context) {
3428
return new Container(
3529
child: new PhotoView(
36-
imageProvider: imageProvider
30+
imageProvider: AssetImage("assets/large-image.jpg"),
31+
minScale: PhotoViewScaleBoundary.contained * 0.8,
32+
maxScale: 4.0,
3733
);
3834
);
3935
}
@@ -63,14 +59,23 @@ For more information about how to use Photo View, check the [API Docs](/API.md)
6359
### Screenshots
6460

6561

66-
| Large image | Small image |
67-
| ------------- | ------------- |
68-
| ![In action](https://github.com/renancaraujo/photo_view/blob/master/screen1.gif) | ![In action](https://github.com/renancaraujo/photo_view/blob/master/screen2.gif) |
62+
| Large image | Small image | Animated GIF | Limited scale | Inline |
63+
| ------------- | ------------- | ------------- | ------------- | ------------- |
64+
| ![In action](https://github.com/renancaraujo/photo_view/blob/master/screen1.gif) | ![In action](https://github.com/renancaraujo/photo_view/blob/master/screen2.gif) | ![In action](https://github.com/renancaraujo/photo_view/blob/master/screen3.gif) | ![In action](https://github.com/renancaraujo/photo_view/blob/master/screen4.gif) | ![In action](https://github.com/renancaraujo/photo_view/blob/master/screen5.gif) |
65+
66+
67+
## Todo:
6968

70-
| Animated GIF | Limited scale |
71-
| ------------- | ------------- |
72-
| ![In action](https://github.com/renancaraujo/photo_view/blob/master/screen3.gif) | ![In action](https://github.com/renancaraujo/photo_view/blob/master/screen4.gif) |
69+
- [x] Scale on doubleTap
70+
- [x] Zoom when pinched
71+
- [x] Respect screen and image boundaries
72+
- [x] Center image when zooming out
73+
- [x] Add image zoom limits (`minScale` an `maxScale`)
74+
- [x] Add GIF support
75+
- [ ] Multiple image support (Gallery mode)
76+
- [ ] Rotate gesture rotates image ([Work in progress](https://github.com/renancaraujo/photo_view/pull/4))
7377

78+
Pull requests are welcome 😊.
7479

7580

7681

0 commit comments

Comments
 (0)