From adf95bc79580002e290da844b368c0d3e5c74699 Mon Sep 17 00:00:00 2001 From: Lennart Kloock Date: Mon, 13 Jan 2025 19:40:03 +0100 Subject: [PATCH] docs(metrics): root docs --- crates/metrics/src/lib.rs | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/crates/metrics/src/lib.rs b/crates/metrics/src/lib.rs index 66f71fa0e..be94ae5c5 100644 --- a/crates/metrics/src/lib.rs +++ b/crates/metrics/src/lib.rs @@ -1,4 +1,19 @@ -#![doc = include_str!("../README.md")] +//! # scuffle-metrics +//! +//! A wrapper around opentelemetry to provide a more ergonomic interface for creating metrics. +//! +//! ## Status +//! +//! This crate is currently under development and is not yet stable. +//! +//! Unit tests are not yet fully implemented. Use at your own risk. +//! +//! ## License +//! +//! This project is licensed under the [MIT](./LICENSE.MIT) or [Apache-2.0](./LICENSE.Apache-2.0) license. +//! You can choose between one of them if you use this work. +//! +//! `SPDX-License-Identifier: MIT OR Apache-2.0` #[cfg(feature = "prometheus")] /// A copy of the opentelemetry-prometheus crate, updated to work with the