Skip to content

Commit

Permalink
update readme before publishing to npm
Browse files Browse the repository at this point in the history
  • Loading branch information
davi01100100 committed Feb 14, 2022
1 parent ddf61a2 commit 245e486
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,20 @@
[![Join the chat at https://gitter.im/bergben/bergben](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/bergben/bergben?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

# Not actively maintained anymore, looking for maintainer
Unfortunately I don't have time to actively maintain my open source repos anymore. If anyone wants to take over, feel free to contact me anytime, I'd be happy if this project still finds use.

# ng2-img-max
Angular 2 and beyond module to resize images down to a certain width and height or to reduce the quality to fit a certain maximal filesize - all in the browser.

This means, the huge image that the user may select will never even need to be uploaded to the server.

## Demo
A simple demo is available as a plnkr: http:https://plnkr.co/edit/HRi5rQEDCBZb59a0lcPe?p=preview
A simple demo is available on stackblitz: https:https://stackblitz.com/edit/angular-ivy-hnhy6v

## Browser support
This module is supported by all major browsers recent versions (IE 10+).

Make sure to include the following polyfill for `HtmlCanvasElement.toBlob()`: https://www.npmjs.com/package/blueimp-canvas-to-blob

```bash
$ npm install blueimp-canvas-to-blob --save
$ npm install blueimp-canvas-to-blob
```


Expand All @@ -26,10 +23,11 @@ $ npm install blueimp-canvas-to-blob --save

## Install
```bash
$ npm install ng2-img-max --save
$ npm install ng2-img-max
```

### Import the module
Only needed for Angular versions prior to 13
```TypeScript
// app.module.ts
import { NgModule } from '@angular/core';
Expand Down

0 comments on commit 245e486

Please sign in to comment.