Skip to content

Commit ad1940d

Browse files
authored
chore: add basic readmes (#65)
Signed-off-by: Todd Baert <[email protected]>
1 parent f0ecf3b commit ad1940d

File tree

3 files changed

+23
-4
lines changed

3 files changed

+23
-4
lines changed

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
1-
# java-sdk-contrib
1+
# OpenFeature Java Contributions
22

3-
Java SDK contrib
3+
![Experimental](https://img.shields.io/badge/experimental-breaking%20changes%20allowed-yellow)
4+
![Alpha](https://img.shields.io/badge/alpha-release-red)
45

5-
To publish:
6-
`mvn --no-transfer-progress --batch-mode --settings release/m2-settings.xml verify deploy -Dversion.modifier='-$GITHUB_SHA-SNAPSHOT'`
6+
This repository is intended for OpenFeature contributions which are not included in the [OpenFeature SDK](https://github.com/open-feature/java-sdk).
7+
8+
The project includes:
9+
10+
- [Providers](./providers)
11+
- [Hooks](./hooks)
12+
13+
## Releases
14+
15+
This repo uses _Release Please_ to release packages. Release Please sets up a running PR that tracks all changes for the library components, and maintains the versions according to [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), generated when [PRs are merged](https://github.com/amannn/action-semantic-pull-request). When Release Please's running PR is merged, any changed artifacts are published.
16+
17+
## License
18+
19+
Apache 2.0 - See [LICENSE](./LICENSE) for more information.

hooks/hooks.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# OpenFeature Java Hooks
2+
3+
Hooks are a mechanism whereby application developers can add arbitrary behavior to flag evaluation. They operate similarly to middleware in many web frameworks. Please see the [spec](https://github.com/open-feature/spec/blob/main/specification/flag-evaluation/hooks.md) for more details.

providers/providers.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# OpenFeature Java Providers
2+
3+
Providers are responsible for performing flag evaluation. They provide an abstraction between the underlying flag management system and OpenFeature itself. This allows providers to be changed without requiring a major code refactor. Please see the [spec](https://github.com/open-feature/spec/blob/main/specification/provider/providers.md) for more details.

0 commit comments

Comments
 (0)