Merge pull request #341 from adorsys/339-update-readme-files

update README files

Author: Hermann-Core

crates/database/README.md

@@ -41,12 +41,12 @@ impl Identifiable for MyEntity {
 
 ```rust
 struct MyEntityRepository {
-    collection: Arc<RwLock<Collection<MyEntity>>>,
+    collection: Collection<MyEntity>,
 }
 
 #[async_trait]
 impl Repository<MyEntity> for MyEntityRepository {
-    fn get_collection(&self) -> Arc<RwLock<Collection<MyEntity>>> {
+    fn get_collection(&self) -> Collection<MyEntity> {
         self.collection.clone()
     }
 }
@@ -57,7 +57,7 @@ impl Repository<MyEntity> for MyEntityRepository {
 ```rust
 let db = get_or_init_database();
 let repo = MyEntityRepository {
-    collection: Arc::new(RwLock::new(db.read().await.collection("my_entities"))),
+    collection: db.collection("my_entities"),
 };
 let entity = MyEntity { id: None, name: "example".to_string() };
 repo.store(entity).await?;

crates/keystore/README.md

@@ -1,18 +1,22 @@
 # Keystore Crate
 
-The `keystore` crate is a utility library for managing cryptographic secrets. It is used in the [Didcomm Mediator](https://github.com/adorsys/didcomm-mediator-rs/) to store and retrieve cryptographic keys for DIDcomm interactions.
+The `keystore` crate is a utility library for managing cryptographic secrets. It is used in the [Didcomm Mediator](https://github.com/adorsys/didcomm-mediator-rs/) to securely store, retrieve and delete cryptographic keys for DIDcomm interactions.
 
 ## Usage
 
 This crate is internal to the [Didcomm Mediator](https://github.com/adorsys/didcomm-mediator-rs/). Below is an example of interacting with the keystore:
 
 ```rust
-use keystore::{KeyStore, Secrets};
-use mongodb::bson::{doc, Bson, Document};
+use keystore::KeyStore;
 use did_utils::jwk::Jwk;
 
+// Create a new AWS KMS client
+let config = aws_config::load_from_env().await;
+let client = aws_sdk_kms::Client::new(&config);
+let key_id = "test-key".to_string();
+
 // Initialize the keystore
-let keystore = KeyStore::get();
+let keystore = KeyStore::with_aws_kms(client, key_id);
 
 let jwk: Jwk = serde_json::from_str(
     r#"{
@@ -25,16 +29,11 @@ let jwk: Jwk = serde_json::from_str(
 .unwrap();
 
 // Store a secret
-let secret = Secrets {
-    id: Some(ObjectId::new()),
-    kid: "key-1".to_string(),
-    secret_material: jwk,
-};
-keystore.store(secret).await?;
+keystore.store("key-1", &jwk).await?;
 
 // Retrieve a secret by ID
-let secret = keystore.find_one(doc! {"kid": "key-1"}).await?;
+let secret: Option<Jwk> = keystore.retrieve("key-1").await?;
 
 // Delete a secret by ID
-keystore.delete_one(secret.id.unwrap()).await?;
+keystore.delete("key-1").await?;
 ```

crates/plugin-api/README.md

@@ -74,3 +74,24 @@ lazy_static! {
     ];
 }
 ```
+
+* **Add the plugin in the root `Cargo.toml`**
+
+```toml
+[workspace]
+members = [
+    ...
+    "crates/web-plugins/my-plugin-name",
+]
+
+[workspace.dependencies]
+my-plugin-name = { path = "./crates/web-plugins/my-plugin-name", version = "0.1.0" }
+
+[features]
+default = [
+    ...
+    "plugin-myplugin"
+]
+
+plugin-myplugin = [deps:my-plugin-name]
+```

crates/web-plugins/did-endpoint/README.md

@@ -20,7 +20,7 @@ let storage_dirpath = std::env::var("STORAGE_DIRPATH").unwrap(),
 let server_public_domain = std::env::var("SERVER_PUBLIC_DOMAIN").unwrap();
 
 let mut filesystem = filesystem::StdFileSystem;
-let keystore = keystore::KeyStore::get();
+let keystore = keystore::KeyStore::with_mongodb();
 
 // Generate and persist a new DID document
 didgen::didgen(

crates/web-plugins/didcomm-messaging/did-utils/README.md

@@ -5,8 +5,9 @@ A Rust library for implementing reusable utility code for DID-based applications
 ## Features
 
 * Manipulate JSON DID documents.
-* Create keys.
-* Sign, verify, encrypt, and decrypt DID documents.
+* Create and manage cryptographic keys.
+* Sign, verify, encrypt, and decrypt content.
+* Various DID methods implementations.
 
 ## Installation
 
@@ -17,31 +18,6 @@ Add this to your `Cargo.toml`:
 did-utils = "0.1"
 ```
 
-## Usage
-
-```rust
-use did_utils::*;
-
-// Create a DID document.
-let did_document = DidDocument::new(
-    "did:example:1234567890",
-    "My DID",
-    "My public key",
-);
-
-// Sign the DID document.
-let signature = did_document.sign(&my_private_key);
-
-// Verify the signature of the DID document.
-let is_valid = did_document.verify_signature(&signature);
-
-// Encrypt the DID document.
-let encrypted_did_document = did_document.encrypt(&my_public_key);
-
-// Decrypt the encrypted DID document.
-let decrypted_did_document = encrypted_did_document.decrypt(&my_private_key);
-```
-
 ## Documentation
 
 The documentation for the library is available [here](https://docs.rs/did-utils)

crates/web-plugins/didcomm-messaging/message-api/README.md

@@ -0,0 +1,3 @@
+# Interface for registering DIDComm messaging protocols as plugins
+
+See the [mock-protocol](../README.md) implementation for an example of how to implement a new protocol in the [project](https://github.com/adorsys/didcomm-mediator-rs).

crates/web-plugins/didcomm-messaging/protocols/README.md

@@ -0,0 +1,3 @@
+# DIDComm Messaging protocols
+
+You can find the list of currently supported protocols in the [README](https://github.com/adorsys/didcomm-mediator-rs#project-feature-implementation-tracker).