From 8eb0b70f0a3cb2a77dc4514d77861d85c10ff6bf Mon Sep 17 00:00:00 2001
From: Cayo Puigdefabregas <cayo@usody.com>
Date: Thu, 30 May 2024 11:12:04 +0200
Subject: [PATCH] add did web in README

---
 README.md    | 35 ++++++++++++++++++++++++++++++++---
 README_es.md | 35 +++++++++++++++++++++++++++++++++++
 2 files changed, 67 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index ae0d6ff..cb25ff9 100644
--- a/README.md
+++ b/README.md
@@ -20,7 +20,7 @@ For now the installation is from the repository:
     pip install -e .
 ```
 
-#Cli
+# Cli
 The mode of use under the command line would be the following:
 
 ## generate a key pair:
@@ -29,8 +29,15 @@ The mode of use under the command line would be the following:
 ```
 
 ## generate a did identifier:
+
+### did key
 ```sh
-    python did.py -n did -k keypair.json
+  python did.py -n did -k keypair.json
+```
+
+### did web
+```sh
+  python did.py -n did -k keypair.json -u https://localhost/user1/dids/
 ```
 
 ## generate an example signed credential:
@@ -54,7 +61,7 @@ An example of a credential is generated, which is the one that appears in the cr
     python verify_vp.py presentation_signed.json
 ```
 
-# Use as a lib
+# Use as a library
 In the tests you can find examples of use. Now I will explain the usual cases
 
 ## generate a key pair:
@@ -64,12 +71,22 @@ In the tests you can find examples of use. Now I will explain the usual cases
 ```
 
 ## generate a did identifier:
+
+### did key
 ```python
     from pyvckit.did import generate_keys, generate_did
     key = generate_keys()
     did = generate_did(key)
 ```
 
+### did web
+```python
+    from pyvckit.did import generate_keys, generate_did
+    key = generate_keys()
+    url = "https://localhost/user1/dids/"
+    did = generate_did(key, url)
+```
+
 ## generate a signed credential:
 Assuming **credential** is a valid credential.
 **credential** is a string variable
@@ -108,3 +125,15 @@ Assuming **vc** is a properly signed verifiable credential
     from pyvckit.verify_vp import verify_vp
     verified = verify_vp(json.dumps(vp))
 ```
+
+## creation of did document:
+This command will create a json document and a url path where to place this document. The did must be a web did.
+This document is an example and in production it must be adapted to contain the revoked verifiable credentials.
+```python
+    from pyvckit.did import generate_keys, generate_did, gen_did_document
+
+    key = generate_keys()
+    url = "https://localhost/did-registry"
+    did = generate_did(key, url)
+    definitive_url, document = gen_did_document(did, key)
+```
diff --git a/README_es.md b/README_es.md
index 4449154..fb3ba23 100644
--- a/README_es.md
+++ b/README_es.md
@@ -29,10 +29,17 @@ El modo de uso bajo la linea de comandos seria el siguiente:
 ```
 
 ## generar un identificador did:
+
+### did key
 ```sh
   python did.py -n did -k keypair.json
 ```
 
+### did web
+```sh
+  python did.py -n did -k keypair.json -u https://localhost/user1/dids/
+```
+
 ## generar una credencial firmada de ejemplo:
 Se genera un ejemplo de credencial que es el que aparece en la plantilla credential_tmpl del fichero [templates.py](templates.py)
 ```sh
@@ -54,6 +61,12 @@ Se genera un ejemplo de credencial que es el que aparece en la plantilla credent
   python verify_vp.py presentation_signed.json
 ```
 
+## creación del documento did:
+Este comando creara un documento json y una ruta url donde colocar este documento. El did tiene que ser un did web.
+```sh
+  python did.py -k keypair.json -g did:web:localhost:did-registry:z6MkiNc8xqJLcG7QR1wzD9HPs5oPQEaWNcVf92QsbppNiB7C
+```
+
 # Uso como librería
 En los test podras encontrar ejemplos de uso. Ahora explicare los casos habituales
 
@@ -64,12 +77,22 @@ En los test podras encontrar ejemplos de uso. Ahora explicare los casos habitual
 ```
 
 ## generar un identificador did:
+
+### did key
 ```python
     from pyvckit.did import generate_keys, generate_did
     key = generate_keys()
     did = generate_did(key)
 ```
 
+### did web
+```python
+    from pyvckit.did import generate_keys, generate_did
+    key = generate_keys()
+    url = "https://localhost/user1/dids/"
+    did = generate_did(key, url)
+```
+
 ## generar una credencial firmada:
 Suponiendo que **credential** es una credencial válida.
 **credential** es una variable de tipo string
@@ -108,3 +131,15 @@ Suponiendo que **vc** es una credencial verificable correctamente firmada
     from pyvckit.verify_vp import verify_vp
     verified = verify_vp(json.dumps(vp))
 ```
+
+## creación del documento did:
+Este comando creara un documento json y una ruta url donde colocar este documento. El did tiene que ser un did web.
+Este documento es un ejemplo y en producción hay que adaptarlo para contener las credenciales verificables revocadas.
+```python
+    from pyvckit.did import generate_keys, generate_did, gen_did_document
+
+    key = generate_keys()
+    url = "https://localhost/did-registry"
+    did = generate_did(key, url)
+    definitive_url, document = gen_did_document(did, key)
+```