include logo in the readme

README.md

@@ -1,8 +1,10 @@
-# `emit`
+<h1 style="display: flex; align-items: center">
+<img style="display: inline" height="80px" width="80px" src="https://raw.githubusercontent.com/KodrAus/emit/main/asset/logo.svg" aria-hidden="true"> emit
+</h1>
 
 [![all](https://github.com/KodrAus/emit/actions/workflows/all.yml/badge.svg)](https://github.com/KodrAus/emit/actions/workflows/all.yml)
 
-Structured diagnostics for Rust applications.
+## Structured diagnostics for Rust applications.
 
 `emit` is a structured logging framework for manually instrumenting Rust applications with an expressive syntax inspired by [Message Templates](https://messagetemplates.org).
 

batcher/src/lib.rs

@@ -13,6 +13,8 @@ This library implements a channel that can be used to spawn background workers o
 This library is still experimental, so its API may change.
 */
 
+#![doc(html_logo_url = "https://raw.githubusercontent.com/KodrAus/emit/main/asset/logo.svg")]
+
 #![deny(missing_docs)]
 
 use crate::internal_metrics::InternalMetrics;

core/src/lib.rs

@@ -10,6 +10,8 @@ If you're looking to explore and understand `emit`'s API, you can start with [`r
 If you're looking to use `emit` in an application you can use this library directly, but `emit` itself is recommended.
 */
 
+#![doc(html_logo_url = "https://raw.githubusercontent.com/KodrAus/emit/main/asset/logo.svg")]
+
 #![deny(missing_docs)]
 #![cfg_attr(not(test), no_std)]
 

emitter/file/src/lib.rs

@@ -85,6 +85,8 @@ Diagnostic events are written to files in asynchronous batches. Under normal ope
 If writing a batch fails while attempting to write to a file then the file being written to is considered poisoned and no future attempts will be made to write to it. The batch will instead be retried on a new file. Batches that fail attempting to sync are not retried. Since batches don't have explicit transactions, it's possible on failure for part or all of the failed batch to actually be present in the original file. That means diagnostic events may be duplicated in the case of an IO error while writing them.
 */
 
+#![doc(html_logo_url = "https://raw.githubusercontent.com/KodrAus/emit/main/asset/logo.svg")]
+
 #![deny(missing_docs)]
 
 mod internal_metrics;

emitter/opentelemetry/src/lib.rs

@@ -40,6 +40,8 @@ Diagnostic events produced by the [`macro@emit::span`] macro are sent to an [`op
 This library doesn't support `emit`'s metrics as OpenTelemetry metrics. Any metric samples produced by `emit` will be emitted as log records.
 */
 
+#![doc(html_logo_url = "https://raw.githubusercontent.com/KodrAus/emit/main/asset/logo.svg")]
+
 #![deny(missing_docs)]
 
 use std::{cell::RefCell, fmt, ops::ControlFlow, sync::Arc};

emitter/otlp/src/lib.rs

@@ -1161,6 +1161,8 @@ fn main() {
 Diagnostics include when batches are emitted, and any failures observed along the way.
 */
 
+#![doc(html_logo_url = "https://raw.githubusercontent.com/KodrAus/emit/main/asset/logo.svg")]
+
 #![deny(missing_docs)]
 
 #[macro_use]

emitter/term/src/lib.rs

@@ -48,6 +48,8 @@ fn main() {
 ```
 */
 
+#![doc(html_logo_url = "https://raw.githubusercontent.com/KodrAus/emit/main/asset/logo.svg")]
+
 #![deny(missing_docs)]
 
 use core::{fmt, str, time::Duration};

macros/src/lib.rs

@@ -16,6 +16,8 @@ This crate contains the proc-macros that are exported in the `emit` crate. It ex
 Code is transformed through _hooks_. A hook is a well-known method call, like `a.__private_emit_capture_as_default()`. The behavior of the hook is defined in `emit::macro_hooks`. Attribute macros look for these hooks and replace them to change behavior. For example, `#[emit::as_debug]` looks for any `__private_emit_capture_as_*` method and replaces it with `__private_emit_capture_as_debug`.
 */
 
+#![doc(html_logo_url = "https://raw.githubusercontent.com/KodrAus/emit/main/asset/logo.svg")]
+
 extern crate proc_macro;
 
 #[macro_use]

src/lib.rs

@@ -553,6 +553,8 @@ fn main() {
 ```
 */
 
+#![doc(html_logo_url = "https://raw.githubusercontent.com/KodrAus/emit/main/asset/logo.svg")]
+
 #![deny(missing_docs)]
 #![cfg_attr(not(any(test, feature = "std")), no_std)]