Skip to content
This repository was archived by the owner on Jan 29, 2022. It is now read-only.

Commit b20b7be

Browse files
committed
fix: add deprecation information
1 parent 6e2ec0e commit b20b7be

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
**ℹ️ Please note that this package has reached its end. After getting into the React world 2018, I lost the contact into the Angular Ecosystem. With Ionic 6, Slider.js will also be split off, which will probably make this package incompatible for now. Unfortunately I don't have the time to develop this package further according to the demands - thank you for your trust and responses, I appreciated it very much. Feel free to fork this package and work on a successor. You will find here a good tutorial how to create your own image viewer, which is based on the same approach: https://www.youtube.com/watch?v=VCUpRkRi00w**
2+
13
# ngx-ionic-image-viewer <!-- omit in toc -->
24

35
<p>
@@ -8,7 +10,7 @@
810
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
911
</a>
1012
<a href="https://github.com/simongolms/ngx-ionic-image-viewer/graphs/commit-activity" target="_blank">
11-
<img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
13+
<img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-no-red.svg" />
1214
</a>
1315
<a href="https://conventionalcommits.org" target="_blank">
1416
<img alt="Conventional Commits" src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg" />
@@ -105,11 +107,12 @@ export class HomePageModule {}
105107
Add `ion-img-viewer` within the HTML of your module (e.g. `home.page.html`)
106108

107109
```html
108-
<ion-img-viewer
109-
title="Demo"
110-
text="Component"
111-
scheme="dark"
112-
src="./assets/img/demo.jpg">
110+
<ion-img-viewer
111+
title="Demo"
112+
text="Component"
113+
scheme="dark"
114+
src="./assets/img/demo.jpg"
115+
>
113116
</ion-img-viewer>
114117
```
115118

@@ -118,12 +121,13 @@ Add `ion-img-viewer` within the HTML of your module (e.g. `home.page.html`)
118121
Add `ionImgViewer` as a directive within the `ion-img` HTML element of your module (e.g. `home.page.html`)
119122

120123
```html
121-
<ion-img
122-
ionImgViewer
123-
title="Demo"
124-
text="Directive"
125-
scheme="light"
126-
src="./assets/img/demo.jpg">
124+
<ion-img
125+
ionImgViewer
126+
title="Demo"
127+
text="Directive"
128+
scheme="light"
129+
src="./assets/img/demo.jpg"
130+
>
127131
</ion-img>
128132
```
129133

@@ -403,7 +407,7 @@ This project was generated with [Angular CLI](https://github.com/angular/angular
403407

404408
### Local Development
405409

406-
1. Run the command to start the build every time a file change:
410+
1. Run the command to start the build every time a file change:
407411

408412
```bash
409413
npm run build:watch

0 commit comments

Comments
 (0)