Add details to READMEs (HewlettPackard#165)

Signed-off-by: Max Lambrecht <[email protected]>

README.md

@@ -19,6 +19,19 @@ The `spiffe-tls` module is currently in experimental development and aims to pro
 TLS utilities. Its primary goal is to streamline the integration of SPIFFE identities into TLS contexts, facilitating
 not only mutual TLS configurations but also enhancing certificate validation processes.
 
+## Installation
+
+`spiffe` module:
+
+```sh
+pip install spiffe
+```
+
+`spiffe-tls` module:
+```sh
+pip install spiffe-tls
+```
+
 ## Contributing
 
 Contributions to both `spiffe` and the `spiffe-tls` modules are welcome! Please see

spiffe-tls/README.md

@@ -1,4 +1,4 @@
-# `spiffe-tls` Module
+# `spiffe-tls` module (experimental)
 
 This `py-spiffe` module provides TLS utilities that facilitate creating secure TLS connections leveraging SPIFFE IDs for
 authentication. It wraps [pyOpenSSL](https://pypi.org/project/pyOpenSSL/), offering easy-to-use functions for setting up
@@ -47,7 +47,7 @@ x509_source = X509Source()
 conn = dial(
     "localhost:8443",
     x509_source,
-    authorize_fn=authorize_id(SpiffeId("spiffe://example.org/client-service")),
+    authorize_fn=authorize_id(SpiffeId("spiffe://example.org/server")),
 )
 ```
 

spiffe/README.md

@@ -1,14 +1,13 @@
-# `spiffe` Module
+# `spiffe` module
 
 ## Overview
 
 The `spiffe` module, part of the `py-spiffe` library, provides Python developers with essential tools for interacting
-with
-the [SPIFFE Workload API](https://github.com/spiffe/spiffe/blob/main/standards/SPIFFE_Workload_API.md). It streamlines
-the management and validation of SPIFFE identities, including support for
-both [X509-SVIDs](https://github.com/spiffe/spiffe/blob/main/standards/X509-SVID.md)
-and [JWT-SVIDs](https://github.com/spiffe/spiffe/blob/main/standards/JWT-SVID.md), and
-[SPIFFE Bundles](https://github.com/spiffe/spiffe/blob/main/standards/SPIFFE_Trust_Domain_and_Bundle.md#3-spiffe-bundles).
+with the [SPIFFE Workload API](https://github.com/spiffe/spiffe/blob/main/standards/SPIFFE_Workload_API.md). It
+streamlines the management and validation of SPIFFE identities, including support
+for both [X509-SVIDs](https://github.com/spiffe/spiffe/blob/main/standards/X509-SVID.md)
+and [JWT-SVIDs](https://github.com/spiffe/spiffe/blob/main/standards/JWT-SVID.md),
+and [SPIFFE Bundles](https://github.com/spiffe/spiffe/blob/main/standards/SPIFFE_Trust_Domain_and_Bundle.md#3-spiffe-bundles).
 
 ## Usage