Skip to content

Commit

Permalink
readme and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
renancaraujo committed Aug 13, 2018
1 parent 0391afb commit 94d7922
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 19 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## [0.0.1] - TODO: Add release date.
# CHANGELOG

* TODO: Describe initial release.
See [REleases page on github](https://github.com/renancaraujo/photo_view/releases)
39 changes: 22 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,11 @@ Resolves a image provider and show the result with useful gestures support, such

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

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

Pull requests are welcome 😊.

## Sample code

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


| Large image | Small image |
| ------------- | ------------- |
| ![In action](https://github.com/renancaraujo/photo_view/blob/master/screen1.gif) | ![In action](https://github.com/renancaraujo/photo_view/blob/master/screen2.gif) |
| Large image | Small image | Animated GIF | Limited scale | Inline |
| ------------- | ------------- | ------------- | ------------- | ------------- |
| ![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) |


## Todo:

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

Pull requests are welcome 😊.



Expand Down
Binary file added screen5.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 94d7922

Please sign in to comment.