Skip to content
This repository has been archived by the owner on Nov 1, 2022. It is now read-only.

Commit

Permalink
Issue #542: Fretboard: Remove deleted RegionProvider from README
Browse files Browse the repository at this point in the history
Closes #542: Fretboard: Remove deleted RegionProvider from README
  • Loading branch information
fercarcedo authored and pocmo committed Aug 2, 2018
1 parent e4d9463 commit 6e856a4
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions components/service/fretboard/README.md
Expand Up @@ -9,7 +9,7 @@ An Android framework for segmenting users in order to run A/B tests and rollout
Use gradle to download the library from JCenter: Use gradle to download the library from JCenter:


```Groovy ```Groovy
implementation "org.mozilla.components:fretboard:{latest-version} implementation "org.mozilla.components:fretboard:{latest-version}"
``` ```


### Creating Fretboard instance ### Creating Fretboard instance
Expand Down Expand Up @@ -153,9 +153,10 @@ Fretboard allows you to specify the following filters:
- device (regex): Android device name - device (regex): Android device name
- manufacturer (regex): Android device manufacturer - manufacturer (regex): Android device manufacturer
- region: custom region, different from the one from the default locale (like a GeoIP, or something similar). - region: custom region, different from the one from the default locale (like a GeoIP, or something similar).
For this to work you must provide a RegionProvider implementation when creating the `Fretboard` instance.
- release channel: release channel of the app (alpha, beta, etc) - release channel: release channel of the app (alpha, beta, etc)


For region and release channel to work you must provide a `ValuesProvider` implementation when creating the `Fretboard` instance, as detailed below

### Specifying custom values for filters ### Specifying custom values for filters
Additionally, Fretboard allows you to specify a custom `ValuesProvider` object in order to return a custom region, Additionally, Fretboard allows you to specify a custom `ValuesProvider` object in order to return a custom region,
different from the one of the current locale (perhaps doing a GeoIP or something like that), or the app different from the one of the current locale (perhaps doing a GeoIP or something like that), or the app
Expand Down

0 comments on commit 6e856a4

Please sign in to comment.