10000 [file_selector] Update install instructions (#872) · google/flutter-desktop-embedding@d958b0b · GitHub
[go: up one dir, main page]
Skip to content

Commit d958b0b

Browse files
stuartmorgan-gstuartmorgan-g
authored
[file_selector] Update install instructions (#872)
Link to pub.dev installation instructions instead of showing an example, to make the instructions evergreen.
1 parent bff6051 commit d958b0b

File tree

10 files changed

+54
-61
lines changed

10 files changed

+54
-61
lines changed

‎plugins/file_selector/example/README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
# file_selector_example
2-
3-
Demonstrates how to use the file_selector plugin.
4-
5-
## Getting Started
6-
7-
For help getting started with Flutter, view our online
8-
[documentation](https://flutter.dev/).
1+
# file\_selector\_example
2+
3+
Demonstrates unendorsed desktop implementations of the
4+
[`file_selector` plugin](https://pub.dev/packages/file_selector).

‎plugins/file_selector/file_selector_linux/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## 0.0.2+1
2+
3+
* Update README
4+
15
## 0.0.2
26

37
* Update SDK constraint to signal compatibility with null safety.

‎plugins/file_selector/file_selector_linux/README.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,19 @@
1-
# file_selector_linux
1+
# file\_selector\_linux
22

33
The Linux implementation of [`file_selector`][1].
44

55
## Usage
66

7-
### Import the package
7+
### Importing the package
88

9-
This package has not yet been endorsed, meaning that you need to add `file_selector_linux`
10-
as a dependency in your `pubspec.yaml`. It will be not yet be automatically included in your app
11-
when you depend on `package:file_selector`.
9+
This implementation has not yet been endorsed, meaning that you need to
10+
[depend on `file_selector_linux`][2] in addition to
11+
[depending on `file_selector`][3].
1212

13-
This is what the above means to your `pubspec.yaml`:
13+
Once your pubspec includes the Linux implementation, you can use the
14+
`file_selector` APIs normally. You should not use the `file_selector_linux`
15+
APIs directly.
1416

15-
```yaml
16-
...
17-
dependencies:
18-
...
19-
file_selector: ^0.7.0
20-
file_selector_linux: ^0.0.2
21-
...
22-
```
23-
24-
[1]: https://github.com/flutter/plugins/tree/master/packages/file_selector
17+
[1]: https://pub.dev/packages/file_selector
18+
[2]: https://pub.dev/packages/file_selector_linux/install
19+
[3]: https://pub.dev/packages/file_selector/install

‎plugins/file_selector/file_selector_linux/pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: file_selector_linux
22
description: Liunx implementation of the file_selector plugin.
3-
version: 0.0.2
3+
version: 0.0.2+1
44
homepage: https://github.com/google/flutter-desktop-embedding/tree/master/plugins/file_selector/file_selector_linux
55

66
flutter:

‎plugins/file_selector/file_selector_macos/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## 0.0.4+1
2+
3+
* Update README
4+
15
## 0.0.4
26

37
* Treat empty filter lists the same as null.

‎plugins/file_selector/file_selector_macos/README.md

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,22 @@
1-
# file_selector_macos
1+
# file\_selector\_macos
22

33
The macOS implementation of [`file_selector`][1].
44

55
## Usage
66

7-
### Import the package
7+
### Importing the package
88

9-
This package has not yet been endorsed, meaning that you need to add `file_selector_macos`
10-
as a dependency in your `pubspec.yaml`. It will be not yet be automatically included in your app
11-
when you depend on `package:file_selector`.
9+
This implementation has not yet been endorsed, meaning that you need to
10+
[depend on `file_selector_macos`][2] in addition to
11+
[depending on `file_selector`][3].
1212

13-
This is what the above means to your `pubspec.yaml`:
14-
15-
```yaml
16-
...
17-
dependencies:
18-
...
19-
file_selector: ^0.7.0
20-
file_selector_macos: ^0.0.3
21-
...
22-
```
13+
Once your pubspec includes the macOS implementation, you can use the
14+
`file_selector` APIs normally. You should not use the `file_selector_macos`
15+
APIs directly.
2316

2417
### Entitlements
2518

26-
You will need to [add an entitlement][2] for either read-only access:
19+
You will need to [add an entitlement][4] for either read-only access:
2720
```
2821
<key>com.apple.security.files.user-selected.read-only</key>
2922
<true/>
@@ -35,5 +28,7 @@ or read/write access:
3528
```
3629
depending on your use case.
3730

38-
[1]: https://github.com/flutter/plugins/tree/master/packages/file_selector
39-
[2]: https://flutter.dev/desktop#entitlements-and-the-app-sandbox
31+
[1]: https://pub.dev/packages/file_selector
32+
[2]: https://pub.dev/packages/file_selector_macos/install
33+
[3]: https://pub.dev/packages/file_selector/install
34+
[4]: https://flutter.dev/desktop#entitlements-and-the-app-sandbox

‎plugins/file_selector/file_selector_macos/pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: file_selector_macos
22
description: macOS implementation of the file_selector plugin.
3-
version: 0.0.4
3+
version: 0.0.4+1
44
homepage: https://github.com/google/flutter-desktop-embedding/tree/master/plugins/file_selector/file_selector_macos
55

66
flutter:

‎plugins/file_selector/file_selector_windows/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## 0.0.2+1
2+
3+
* Update README
4+
15
## 0.0.2
26

37
* Update SDK constraint to signal compatibility with null safety.

‎plugins/file_selector/file_selector_windows/README.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,19 @@
1-
# file_selector_windows
1+
# file\_selector\_windows
22

33
The Windows implementation of [`file_selector`][1].
44

55
## Usage
66

7-
### Import the package
7+
### Importing the package
88

9-
This package has not yet been endorsed, meaning that you need to add `file_selector_windows`
10-
as a dependency in your `pubspec.yaml`. It will be not yet be automatically included in your app
11-
when you depend on `package:file_selector`.
9+
This implementation has not yet been endorsed, meaning that you need to
10+
[depend on `file_selector_windows`][2] in addition to
11+
[depending on `file_selector`][3].
1212

13-
This is what the above means to your `pubspec.yaml`:
13+
Once your pubspec includes the Windows implementation, you can use the
14+
`file_selector` APIs normally. You should not use the `file_selector_windows`
15+
APIs directly.
1416

15-
```yaml
16-
...
17-
dependencies:
18-
...
19-
file_selector: ^0.7.0
20-
file_selector_windows: ^0.0.2
21-
...
22-
```
23-
24-
[1]: https://github.com/flutter/plugins/tree/master/packages/file_selector
17+
[1]: https://pub.dev/packages/file_selector
18+
[2]: https://pub.dev/packages/file_selector_windows/install
19+
[3]: https://pub.dev/packages/file_selector/install

‎plugins/file_selector/file_selector_windows/pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: file_selector_windows
22
description: Windows implementation of the file_selector plugin.
3-
version: 0.0.2
3+
version: 0.0.2+1
44
homepage: https://github.com/google/flutter-desktop-embedding/tree/master/plugins/file_selector/file_selector_windows
55

66
flutter:

0 commit comments

Comments
 (0)
0