update readme

.devcontainer/devcontainer.json

@@ -7,7 +7,7 @@
 	// Use 'forwardPorts' to make a list of ports inside the container available locally.
 	// "forwardPorts": [],
 	// Uncomment the next line to run commands after the container is created - for example installing curl.
-	// "postCreateCommand": "apt-get update && apt-get install -y curl",
+	"postCreateCommand": "python3 -m pip install -e .",
 	// Uncomment when using a ptrace-based debugger like C++, Go, and Rust
 	// "runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined" ],
 	// Uncomment to use the Docker CLI from inside the container. See https://aka.ms/vscode-remote/samples/docker-from-docker.
@@ -25,6 +25,7 @@
 			]
 		}
 	},
+	"containerUser": "root",
 	"workspaceMount": "source=${localWorkspaceFolder},target=/home/Alice/asciinema_automation,type=bind,consistency=cached",
 	"workspaceFolder": "/home/Alice/asciinema_automation"
 }

README.rst

@@ -9,6 +9,17 @@ asciinema-automation
 
 asciinema-automation is a Python package which provides a small CLI utility to automate `asciinema <https://asciinema.org>`_ recordings. The only dependencies are asciinema and `Pexpect <https://pexpect.readthedocs.io/>`_.
 
+Recording is made easier by:
+
+- making the live recording for you, to get the perfect take in one go (no more missed keys!),
+- while looking not too robotic by adding Gaussian delay between keystrokes.
+
+One specificity of this package is that 
+
+- it makes automated recording as **reproducible and robust** as possible. In particular, there is no need to add a manually set waiting time between commands to wait for previous outputs. 
+
+To that end, you can write the commands you wish to showcase in a text file, and using comment lines starting by :code:`#$` (see `examples` folder and `example`_), you can specify the expected output of each command, and/or change the configuration of the automated recording on-the-fly.
+
 Example
 -------