Skip to content

Commit d54b123

Browse files
authored
Standardized the README format
1 parent d7d70bd commit d54b123

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

.github/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
**NOTE:** Universal Windows Platform (UWP) is not supported!
2323

24-
## HOW TO
24+
## INSTALLATION
2525

2626
There are 4 ways to install this plugin:
2727

@@ -31,12 +31,14 @@ There are 4 ways to install this plugin:
3131
- *(via Package Manager)* add the following line to *Packages/manifest.json*:
3232
- `"com.yasirkula.simplefilebrowser": "https://github.com/yasirkula/UnitySimpleFileBrowser.git",`
3333

34-
Afterwards, add `using SimpleFileBrowser;` to your script.
34+
## HOW TO
3535

3636
*for Android*: set **Write Permission** to **External (SDCard)** in **Player Settings**
3737

3838
**NOTE:** On *Android Q (10)* or later, it is impossible to work with *File* APIs. On these devices, SimpleFileBrowser uses *Storage Access Framework (SAF)* to browse the files. However, paths returned by SAF are not File API compatible. To simulate the behaviour of the File API on all devices (including SAF), you can check out the **FileBrowserHelpers** functions. For reference, here is an example SAF path: `content://com.android.externalstorage.documents/tree/primary%3A/document/primary%3APictures`
3939

40+
First, add `using SimpleFileBrowser;` to your script.
41+
4042
The file browser can be shown either as a **save dialog** or a **load dialog**. In load mode, the returned path always leads to an existing file or folder. In save mode, the returned path can point to a non-existing file, as well. You can use the following functions to show the file browser:
4143

4244
```csharp

0 commit comments

Comments
 (0)