Skip to content

Commit

Permalink
Update README and CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
nkalupahana committed Apr 29, 2024
1 parent 59bd8f3 commit c810f09
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 8 deletions.
12 changes: 11 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# Changelog

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
All notable changes to this project will be documented in this file.

## [6.0.0](https://github.com/capacitor-community/media/compare/v5.4.1...v6.0.0) (2024-04-29)
- Update to Capacitor 6
- Fix missing source maps
- Add `getMediaByIdentifier()` to get full-size media to web layer on iOS
- Improve error handling on Android
- Improve download performance on Android
- Add error codes to promise rejections
- Handle image URLs without extensions properly on Android
- Remove `saveGif` -- functionality is now in `savePhoto`

## [5.4.1](https://github.com/capacitor-community/media/compare/v5.4.0...v5.4.1) (2024-04-02)
- Update `getMedias()` to also return video thumbnails
Expand Down
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<h3 align="center">Capacitor Media</h3>
<p align="center"><strong><code>@capacitor-community/media</code></strong></p>
<p align="center">
Capacitor community plugin for enabling extra media capabilities
Capacitor plugin for saving and retrieving photos and videos, and managing photo albums.
</p>

<p align="center">
Expand Down Expand Up @@ -43,20 +43,19 @@

## Installation

Run one of the following commands, based on what you're using:

```bash
npm install @capacitor-community/media # NPM
yarn add @capacitor-community/media # Yarn
npm install @capacitor-community/media
```

This plugin is currently for Capacitor 6. Add an `@5` at the end to install for Capacitor 5.

After installing, be sure to sync by running `ionic cap sync`.

## Migrating to Capacitor 5
## Migrating to Capacitor 6

**A major breaking change has been made to this plugin:** Saving media on Android now takes an album identifier instead of an album name. The album identifier, like on iOS, can be obtained using `getAlbums()`. (This call will now also return empty albums made by the plugin.) To ensure people notice this significant change, the property has been renamed from `album` to `albumIdentifier`, which will need to be updated in your code. It is still optional on iOS.
There are a few breaking changes to take note of:
- `saveGif` no longer exists. Use `savePhoto` for images and GIFs.
- Error text has been changed. If you were checking for specific error messages, you should now use `error.code`, which will be `accessDenied`, `argumentError`, `downloadError`, or `filesystemError`.

## API

Expand Down

0 comments on commit c810f09

Please sign in to comment.