fix: OFREP fix cargo publish, use cargo readme to align with cargodoc (#62)

Signed-off-by: Eren Atas <[email protected]>

Author: erenatas

crates/ofrep/Cargo.toml

@@ -1,5 +1,10 @@
 [package]
 name = "open-feature-ofrep"
+description = "The official OpenFeature Remote Evaluation Protocol (OFREP) provider for OpenFeature."
+documentation = "https://docs.rs/open-feature-ofrep"
+homepage = "https://openfeature.dev/"
+license = "Apache-2.0"
+repository = "https://github.com/open-feature/rust-sdk-contrib"
 version = "0.0.2"
 edition = "2024"
 

crates/ofrep/README.md

@@ -6,7 +6,7 @@ feature flag evaluation in your applications.
 
 This provider allows to connect to any feature flag management system that supports OFREP.
 
-### Installation
+#### Installation
 Add the dependency in your `Cargo.toml`:
 ```bash
 cargo add open-feature-ofrep
@@ -29,7 +29,7 @@ async fn main() {
     let provider = OfrepProvider::new(OfrepOptions {
         base_url: "http://localhost:8016".to_string(),
         headers: headers.clone(),
-        connect_timeout: Duration::from_secs(4), 
+        connect_timeout: Duration::from_secs(4),
         ..Default::default()
     }).await.unwrap();
 
@@ -42,7 +42,7 @@ async fn main() {
 }
 ```
 
-### Configuration Options
+#### Configuration Options
 Configurations can be provided as constructor options. The following options are supported:
 
 | Option                                  | Type / Supported Value            | Default                             |
@@ -51,6 +51,5 @@ Configurations can be provided as constructor options. The following options are
 | headers                                 | HeaderMap                         | Empty Map                           |
 | connect_timeout                         | Duration                          | 10 seconds                          |
 
-### License
+#### License
 Apache 2.0 - See [LICENSE](./../../LICENSE) for more information.
-

crates/ofrep/src/lib.rs

@@ -1,3 +1,59 @@
+//! [Generated by cargo-readme: `cargo readme --no-title --no-license > README.md`]::
+//!  # OFREP Provider for OpenFeature
+//!
+//! A Rust implementation of the OpenFeature OFREP provider, enabling dynamic
+//! feature flag evaluation in your applications.
+//!
+//! This provider allows to connect to any feature flag management system that supports OFREP.
+//!
+//! ### Installation
+//! Add the dependency in your `Cargo.toml`:
+//! ```bash
+//! cargo add open-feature-ofrep
+//! cargo add open-feature
+//! ```
+//! Then integrate it into your application:
+//!
+//! ```rust,no_run
+//! use std::time::Duration;
+//! use open_feature::provider::FeatureProvider;
+//! use open_feature::EvaluationContext;
+//! use open_feature_ofrep::{OfrepProvider, OfrepOptions};
+//! use reqwest::header::{HeaderMap, HeaderValue};
+//!
+//! #[tokio::main]
+//! async fn main() {
+//!     let mut headers = HeaderMap::new();
+//!     headers.insert("color", HeaderValue::from_static("yellow"));
+//!
+//!     let provider = OfrepProvider::new(OfrepOptions {
+//!         base_url: "http://localhost:8016".to_string(),
+//!         headers: headers.clone(),
+//!         connect_timeout: Duration::from_secs(4),
+//!         ..Default::default()
+//!     }).await.unwrap();
+//!
+//!     let context = EvaluationContext::default()
+//!                     .with_targeting_key("user-123")
+//!                     .with_custom_field("color", "yellow");
+//!
+//!     let result = provider.resolve_bool_value("isColorYellow", &context).await.unwrap();
+//!     println!("Flag value: {}", result.value);
+//! }
+//! ```
+//!
+//! ### Configuration Options
+//! Configurations can be provided as constructor options. The following options are supported:
+//!
+//! | Option                                  | Type / Supported Value            | Default                             |
+//! |-----------------------------------------|-----------------------------------|-------------------------------------|
+//! | base_url                                | string                            | http://localhost:8016               |
+//! | headers                                 | HeaderMap                         | Empty Map                           |
+//! | connect_timeout                         | Duration                          | 10 seconds                          |
+//!
+//! ### License
+//! Apache 2.0 - See [LICENSE](./../../LICENSE) for more information.
+
 mod error;
 mod resolver;