Skip to content

Commit

Permalink
Suites documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
apla committed Jul 16, 2016
1 parent 8df3b1c commit ec96e78
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ Why you should use this plugin?
* Cordova + Promise interface out of the box
* Supports many platforms (Android, iOS/macOS, Windows and local storage fallback)
* Have tests
(iOS: [![iOS status](https://travis-ci.org/apla/me.apla.cordova.app-preferences.svg)](https://travis-ci.org/apla/me.apla.cordova.app-preferences),
(iOS: [![iOS and browser status](https://travis-ci.org/apla/me.apla.cordova.app-preferences.svg)](https://travis-ci.org/apla/me.apla.cordova.app-preferences),
Android: [![Android status](https://circleci.com/gh/apla/me.apla.cordova.app-preferences.svg?&style=shield&circle-token=f3e5e46c1a698c62f0450bf1d25a3694d4f714c6)](https://circleci.com/gh/apla/me.apla.cordova.app-preferences),
Windows: [![Windows status](https://ci.appveyor.com/api/projects/status/gl3qxq2o728sqbev?svg=true)](https://ci.appveyor.com/project/apla/me-apla-cordova-app-preferences))
Windows: [![Windows status](https://ci.appveyor.com/api/projects/status/gl3qxq2o728sqbev?svg=true)](https://ci.appveyor.com/project/apla/me-apla-cordova-app-preferences),
Browser: [![iOS and browser status](https://travis-ci.org/apla/me.apla.cordova.app-preferences.svg)](https://travis-ci.org/apla/me.apla.cordova.app-preferences))
* Supports simple and complex data structures
* Supports removal of the keys
* Have preference pane generator for application (for Android and iOS) and can show native preferences
Expand Down Expand Up @@ -77,6 +78,12 @@ prefs.show (ok, fail);
// fetch the value for a key using promise
prefs.fetch ('key').then (ok, fail);

```

[Suites](wiki/Suites)

```javascript

// support for iOS suites or android named preference files (untested)
var suitePrefs = prefs.suite ("suiteName");
suitePrefs.fetch (...);
Expand Down Expand Up @@ -108,11 +115,11 @@ Tests
---
Tests are available in `src/test.js`. After installing plugin you can add test code from this file and then launch `testPlugin()` function.

* iOS pass locally, Travis: ![iOS status](https://travis-ci.org/apla/me.apla.cordova.app-preferences.svg)
* iOS pass locally, Travis: ![iOS and browser status](https://travis-ci.org/apla/me.apla.cordova.app-preferences.svg)
* Android pass locally, CircleCI: ![Android status](https://circleci.com/gh/apla/me.apla.cordova.app-preferences.svg?&style=shield&circle-token=f3e5e46c1a698c62f0450bf1d25a3694d4f714c6)
* BlackBerry 10 pass locally
* Windows Phone 8 tests pass locally, Appveyor: ![Windows status](https://ci.appveyor.com/api/projects/status/gl3qxq2o728sqbev?svg=true)
* Browser pass locally
* Browser pass locally, Travis: ![iOS and browser status](https://travis-ci.org/apla/me.apla.cordova.app-preferences.svg)

Module update for cordova < 5.x
---
Expand Down

0 comments on commit ec96e78

Please sign in to comment.