Skip to content

Commit 44963b9

Browse files
author
lask
authored
Merge pull request #49 from lakscastro/docs/FULL-DOCS
Add migration notes and missing plugin development guide
2 parents aec489a + 01f6fbf commit 44963b9

File tree

3 files changed

+87
-1
lines changed

3 files changed

+87
-1
lines changed
Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,25 @@
1-
> First you need follow the guide `Setup local environment` in order to read this guide
1+
> First you need follow the guide [`Setup local environment`](./Setup%20local%20environment.md) in order to read this guide
2+
3+
Since this is an Android plugin, you'll need to use Android Studio in order to have a full intellisense and debugging features for Kotlin.
4+
5+
You can also use Visual Studio Code for Dart and Android Studio for Kotlin.
6+
7+
## Android Side
8+
9+
> All android plugin is inside `/android` folder.
10+
11+
There a few steps in order to start debugging this plugin:
12+
13+
- Open the project inside Android Studio.
14+
- Right click on `/android` folder.
15+
- `Flutter` > `Open Android module in Android Studio` > `New Window`.
16+
17+
Done, all completing features will be available.
18+
19+
See [Flutter docs for details](https://docs.flutter.dev/development/tools/android-studio).
20+
21+
## Dart Side
22+
23+
There's no additional step. Just open the directory inside your preferable editor.
24+
25+
Happy hacking.

docs/Migrate notes/From v0.2.0.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
There's some breaking changes from `v0.2.x` then be careful when updating on `pubspec.yaml`
2+
3+
`pubspec.yaml` dependecy manager file:
4+
5+
```yaml
6+
dependencies:
7+
shared_storage: v0.3.0
8+
```
9+
10+
## SDK Constraint
11+
12+
In `android\app\build.gradle` set `android.defaultConfig.minSdkVersion` to `19`:
13+
14+
```gradle
15+
android {
16+
...
17+
defaultConfig {
18+
...
19+
minSdkVersion 19
20+
}
21+
...
22+
}
23+
```
24+
25+
## Plugin Import
26+
27+
Although this import is still supported:
28+
29+
```dart
30+
import 'package:shared_storage/shared_storage.dart' as shared_storage;
31+
```
32+
33+
This should be renamed to any of them or all:
34+
35+
```dart
36+
import 'package:shared_storage/saf.dart' as saf;
37+
import 'package:shared_storage/media_store.dart' as media_store;
38+
import 'package:shared_storage/environment.dart' as environment;
39+
```
40+
41+
Choose which modules/imports one you want to include inside ee project.
42+
43+
## Media Store `getMediaStoreContentDirectory`
44+
45+
In `android\app\build.gradle` set `android.defaultConfig.minSdkVersion` to `19`:
46+
47+
```gradle
48+
android {
49+
...
50+
defaultConfig {
51+
...
52+
minSdkVersion 19
53+
}
54+
...
55+
}
56+
```
57+
58+
The method `getMediaStoreContentDirectory` now returns the right class `Uri` instead of a `Directory`.
59+
60+
Be sure to update all ocurrences.
61+
62+
This `Uri` is used to represent a directory.

docs/Migrate/From v0.2.0.md

Whitespace-only changes.

0 commit comments

Comments
 (0)