Browse Source

[xdga_directories] updated readme

merge-requests/1/head
Vitaliy Zarubin 2 years ago
parent
commit
4d8e41b7ba
  1. 26
      packages/xdga_directories/README.md

26
packages/xdga_directories/README.md

@ -2,7 +2,31 @@
A Dart package for reading directory path on Aurora OS. A Dart package for reading directory path on Aurora OS.
To use this package, the basic XDG values for the following are available via a Dart API: ## Usage
This package can be used alone, but the best solution would be to use `path_provider`.
```yaml
dependencies:
xdga_directories: ^0.0.0 # @todo Not published
```
Then you can import `xdga_directories` in your Dart code:
```dart
import 'package:xdga_directories/xdga_directories.dart' as xdga;
final appDataLocation = xdga.getAppDataLocation();
final cacheLocation = xdga.getCacheLocation();
final documentsLocation = xdga.getDocumentsLocation();
final downloadLocation = xdga.getDownloadLocation();
final musicLocation = xdga.getMusicLocation();
final picturesLocation = xdga.getPicturesLocation();
final genericDataLocation = xdga.getGenericDataLocation();
final moviesLocation = xdga.getMoviesLocation();
```
## Supported APIs
- `getAppDataLocation` - Returns a directory location where persistent application data can be stored. - `getAppDataLocation` - Returns a directory location where persistent application data can be stored.
- `getCacheLocation` - Returns a directory location where user-specific non-essential (cached) data should be written. - `getCacheLocation` - Returns a directory location where user-specific non-essential (cached) data should be written.

Loading…
Cancel
Save