Skip to content

Commit 33d7bfa

Browse files
committed
add readme
1 parent e777e5f commit 33d7bfa

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
2+
[![Swift](https://github.com/fumito-ito/FirebaseRemoteConfig-OpenFeature-Provider-Swift/actions/workflows/swift.yml/badge.svg?branch=main)](https://github.com/fumito-ito/FirebaseRemoteConfig-OpenFeature-Provider-Swift/actions/workflows/swift.yml)
3+
4+
# FirebaseRemoteConfig OpenFeature Provider for Swift
5+
6+
This is yet another OpenFeature provider for [Firebase RemoteConfig](https://firebase.google.com/docs/remote-config?hl=en).
7+
8+
## Installation
9+
10+
### Swift Package Manager
11+
12+
In dependencies section of Package.swift add:
13+
14+
```swift
15+
dependencies: [
16+
.package(
17+
url: "[email protected]:fumito-ito/FirebaseRemoteConfig-OpenFeature-Provider-Swift.git",
18+
.upToNextMajor(from: "0.0.1")
19+
),
20+
]
21+
```
22+
23+
and in the target dependencies section add:
24+
25+
```swift
26+
.product(name: "FirebaseRemoteConfigOpenFeatureProvider", package: "FirebaseRemoteConfig-OpenFeature-Provider-Swift"),
27+
```
28+
29+
## Usage
30+
31+
Import the `FirebaseRemoteConfigOpenFeatureProvider` and `OpenFeature` modules.
32+
33+
```swift
34+
import FirebaseRemoteConfigOpenFeatureProvider
35+
```
36+
37+
Create and set provider.
38+
39+
```swift
40+
let provider = FirebaseRemoteConfigOpenFeatureProvider(remoteConfig: RemoteConfig.remoteConfig())
41+
let context = MutableContext(targetingKey: "your_targeting_key", structure: MutableStructure())
42+
OpenFeatureAPI.shared.setProvider(provider: provider, initialContext: context)
43+
```
44+
45+
## Contributing
46+
47+
Pull requests are welcome. For major changes, please open an issue first
48+
to discuss what you would like to change.
49+
50+
Please make sure to update tests as appropriate.
51+
52+
## License
53+
54+
[Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/)

0 commit comments

Comments
 (0)