Add README.md to individual crates

Signed-off-by: Daiki Ueno <[email protected]>

agent/README.md

@@ -0,0 +1,7 @@
+# crypto-auditing-agent
+
+[![crates.io badge](https://img.shields.io/crates/v/crypto-auditing-agent.svg)](https://crates.io/crates/crypto-auditing-agent)
+
+This crate provides the crypto-auditing-agent executable. To see the whole architecture, see the design [document](https://github.com/latchset/crypto-auditing/blob/main/docs/architecture.md).
+
+To see how to set up and run the daemon, see the [instructions](https://github.com/latchset/crypto-auditing/blob/main/README.md#running).

client/README.md

@@ -0,0 +1,7 @@
+# crypto-auditing-client
+
+[![crates.io badge](https://img.shields.io/crates/v/crypto-auditing-client.svg)](https://crates.io/crates/crypto-auditing-client)
+
+This crate provides the crypto-auditing-client executable. To see the whole architecture, see the design [document](https://github.com/latchset/crypto-auditing/blob/main/docs/architecture.md).
+
+To see how to set up and run the daemon, see the [instructions](https://github.com/latchset/crypto-auditing/blob/main/README.md#running).

crypto-auditing/README.md

@@ -0,0 +1,41 @@
+# crypto-auditing
+
+[![crates.io badge](https://img.shields.io/crates/v/crypto-auditing.svg)](https://crates.io/crates/crypto-auditing)
+
+This crate provides a library interface to interact with the
+crypto-auditing event broker. To see the whole architecture, see the design [document](https://github.com/latchset/crypto-auditing/blob/main/docs/architecture.md).
+
+To use in your project, add into your `Cargo.toml`:
+```toml
+[dependencies]
+crypto-auditing = "0.2"
+```
+
+## Example
+
+The following example connects to the event broker and receives events
+prefixed with "tls::".
+
+```rust
+use crypto_auditing::event_broker::Client;
+use futures::stream::StreamExt;
+
+#[tokio::main]
+async fn main() -> anyhow::Result<()> {
+    let client = Client::new().scopes(&vec!["tls".to_string()]);
+
+    let (_handle, mut reader) = client.start().await?;
+
+    tokio::spawn(async move {
+        while let Some(event) = reader.next().await {
+            println!("{:?}", &event);
+        }
+    });
+
+    tokio::signal::ctrl_c().await?;
+
+    Ok(())
+}
+```
+
+See [full documentation here](https://docs.rs/crypto-auditing).

event-broker/README.md

@@ -0,0 +1,7 @@
+# crypto-auditing-event-broker
+
+[![crates.io badge](https://img.shields.io/crates/v/crypto-auditing-event-broker.svg)](https://crates.io/crates/crypto-auditing-event-broker)
+
+This crate provides the crypto-auditing-event-broker executable. To see the whole architecture, see the design [document](https://github.com/latchset/crypto-auditing/blob/main/docs/architecture.md).
+
+To see how to set up and run the daemon, see the [instructions](https://github.com/latchset/crypto-auditing/blob/main/README.md#running).

log-parser/README.md

@@ -0,0 +1,7 @@
+# crypto-auditing-log-parser
+
+[![crates.io badge](https://img.shields.io/crates/v/crypto-auditing-log-parser.svg)](https://crates.io/crates/crypto-auditing-log-parser)
+
+This crate provides the crypto-auditing-log-parser executable. To see the whole architecture, see the design [document](https://github.com/latchset/crypto-auditing/blob/main/docs/architecture.md).
+
+To see how to set up and run the daemon, see the [instructions](https://github.com/latchset/crypto-auditing/blob/main/README.md#running).