Skip to content

Commit 98f8e41

Browse files
author
Preben Ludviksen
committed
Updated README for 0.0.7.
1 parent 2fd1870 commit 98f8e41

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ Simple file system API for iOS & Android, for dealing with text-files.
44
All interaction is promise-based, and all content is
55
written and read as UTF-8.
66

7-
This library is still under development, and only works on iOS at the current moment.
8-
97
## Setup
108

119
npm install react-native-filesystem --save
@@ -55,7 +53,7 @@ async function checkIfFileExists() {
5553
}
5654
```
5755

58-
### Selecting storage class
56+
### Selecting a storage class
5957

6058
All commands also take an optional last argument specifying a storage class.
6159
These classes roughly correspond to the four points of the
@@ -75,27 +73,27 @@ The default. Files stored in this location will automatically be backed up by iC
7573
[Auto Backup for Apps](https://developer.android.com/guide/topics/data/autobackup.html) on Android
7674
devices running Marshmallow or newer (6.0+). This is where you'd want to put user generated content.
7775

78-
Corresponds to `<Application_Home>/Documents` on iOS and
76+
Corresponds to `<Application_Home>/Documents` on iOS and a subdirectory of
7977
[Context.getFilesDir()](https://developer.android.com/reference/android/content/Context.html#getFilesDir())
8078
on Android.
8179

8280
#### storage.important
8381

84-
This is for files that are possible to re-generate / re-download, but are still important to keep
82+
For files that are possible to re-generate / re-download, but are still important to keep
8583
around during low storage situations. F.ex. offline maps. The system will almost always keep these
8684
files around.
8785

8886
Corresponds to `<Application_Home>/Library/Caches` with "do not backup" flag on iOS, and a
8987
subdirectory of
9088
[Context.getFilesDir()](https://developer.android.com/reference/android/content/Context.html#getFilesDir())
91-
on Android.
89+
excluded from backup on Android.
9290

9391
#### storage.auxiliary
9492

95-
This storage class is for files that can be re-created, and that the app can live without. On
93+
For files that can be re-created, and that the app can live without. On
9694
Android this storage behaves the same as `storage.important`, but on iOS the system can delete
9795
these files in low storage situations. To play it safe, you should gracefully handle the case where
98-
they are gone, by checking their existence.
96+
they are gone, by checking for their existence.
9997

10098
Corresponds to `<Application_Home>/Library/Caches` on iOS, and a subdirectory of
10199
[Context.getFilesDir()](https://developer.android.com/reference/android/content/Context.html#getFilesDir())
@@ -104,7 +102,7 @@ explicitly excluded from backup on Android.
104102

105103
#### storage.temporary
106104

107-
Location for temporary caches and data. The system can get rid of these at any time, but you are
105+
For temporary caches and data. The system can get rid of these at any time, but you are
108106
still required to delete them manually to free up space when they are no longer in use.
109107

110108
Corresponds to `<Application_Home>/tmp` on iOS and

0 commit comments

Comments
 (0)