Skip to content

Commit 4cfef58

Browse files
authored
docs: add develop hook section
Resolves a linting issue in the docs due to an invalid anchor. Left a TODO in the readme for adding a code example. Signed-off-by: Michael Beemer <[email protected]>
1 parent ca30073 commit 4cfef58

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,8 @@
22
<!-- x-hide-in-docs-start -->
33
<p align="center">
44
<picture>
5-
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/open-feature/community/0e23508c163a6a1ac8c0ced3e4bd78faafe627c7/assets/logo/horizontal/white/openfeature-horizontal-white.svg">
6-
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/open-feature/community/0e23508c163a6a1ac8c0ced3e4bd78faafe627c7/assets/logo/horizontal/black/openfeature-horizontal-black.svg">
7-
<img align="center" alt="OpenFeature Logo">
5+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/open-feature/community/0e23508c163a6a1ac8c0ced3e4bd78faafe627c7/assets/logo/horizontal/white/openfeature-horizontal-white.svg" />
6+
<img align="center" alt="OpenFeature Logo" src="https://raw.githubusercontent.com/open-feature/community/0e23508c163a6a1ac8c0ced3e4bd78faafe627c7/assets/logo/horizontal/black/openfeature-horizontal-black.svg" />
87
</picture>
98
</p>
109

@@ -38,7 +37,7 @@
3837

3938
- The Android minSdk version supported is: `21`.
4039

41-
Note that this library is intended to be used in a mobile context, and has not been evaluated for use in other type of applications (e.g. server applications).
40+
Note that this library is intended to be used in a mobile context, and has not been evaluated for use in other types of applications (e.g. server applications).
4241

4342
### Install
4443

@@ -221,7 +220,7 @@ class NewProvider(override val hooks: List<Hook<*>>, override val metadata: Meta
221220
}
222221

223222
override fun initialize(initialContext: EvaluationContext?) {
224-
// add context-aware provider initialisation
223+
// add context-aware provider initialization
225224
}
226225

227226
override fun onContextSet(oldContext: EvaluationContext?, newContext: EvaluationContext) {
@@ -233,6 +232,15 @@ class NewProvider(override val hooks: List<Hook<*>>, override val metadata: Meta
233232

234233
> Built a new provider? [Let us know](https://github.com/open-feature/openfeature.dev/issues/new?assignees=&labels=provider&projects=&template=document-provider.yaml&title=%5BProvider%5D%3A+) so we can add it to the docs!
235234
235+
### Develop a hook
236+
237+
To develop a hook, you need to create a new project and include the OpenFeature SDK as a dependency.
238+
Implement your own hook by conforming to the `Hook` interface exported by the OpenFeature SDK.
239+
240+
<!-- TODO: code example of hook implementation -->
241+
242+
> Built a new hook? [Let us know](https://github.com/open-feature/openfeature.dev/issues/new?assignees=&labels=hook&projects=&template=document-hook.yaml&title=%5BHook%5D%3A+) so we can add it to the docs!
243+
236244
<!-- x-hide-in-docs-start -->
237245
## ⭐️ Support the project
238246

@@ -247,7 +255,7 @@ class NewProvider(override val hooks: List<Hook<*>>, override val metadata: Meta
247255

248256
Interested in contributing? Great, we'd love your help! To get started, take a look at the [CONTRIBUTING](CONTRIBUTING.md) guide.
249257

250-
### Thanks to everyone that has already contributed
258+
### Thanks to everyone who has already contributed
251259

252260
<a href="https://github.com/open-feature/kotlin-sdk/graphs/contributors">
253261
<img src="https://contrib.rocks/image?repo=open-feature/kotlin-sdk" alt="Pictures of the folks who have contributed to the project" />

0 commit comments

Comments
 (0)