Improve the documentation

README.md

@@ -1,6 +1,8 @@
 # Confer [![Made with Haskell](https://img.shields.io/badge/Made%20in-Haskell-%235e5086?logo=haskell&style=flat-square)](https://haskell.org)  [![Configured in Lua](https://img.shields.io/badge/Configured%20in-Lua-%2300007f?logo=lua&style=flat-square)](https://www.lua.org/)
 
-> The dotfiles manager
+Confer is a symbolic link manager that handles the deployment and synchronisation of your configuration files.
+
+Write a configuration file to declare where your files are supposed to go, and `confer` will create the appropriate links.
 
 ## 📖 Documentation
 Read the [Manual](./doc/MANUAL.md) for documentation.
@@ -9,6 +11,7 @@ For more details about the inner workings, read the [Architecture document](./do
 
 ## 📦 Install
 
+### Nightly pre-releases
 Pre-release binaries are available for the following platforms:
 
 * [Linux-x86_64-musl (statically linked)](https://github.com/tchoutri/confer/releases/download/confer-head/confer-head-Linux-static-x86_64.tar.gz)

confer.cabal

@@ -16,6 +16,7 @@ extra-doc-files:
   CHANGELOG.md
   doc/*.md
   README.md
+  doc/confer_example.lua
 
 data-files:      runtime/lua/confer.lua
 tested-with:     GHC ==9.8.2

doc/MANUAL.md

@@ -62,9 +62,11 @@ Override the host name detected in the configuration file.
 
 The configuration is written in a Lua file with facts and deployement rules.
 
-To express a symbolic link of your `.gitconfig` file within your home directory, write:
+For instance, to express a symbolic link of your `.gitconfig` file from the directory where your file are versioned to your home directory, write:
 
 ```lua
+local user = require("user")
+
 local git_deployment = confer.fact({
   -- The name of this fact.
   name = "git",
@@ -85,7 +87,13 @@ local laptop = confer.deploy({
     git_deployment,
     },
 })
+```
+And next we return a table with the configured deployments:
 
+```lua
+return {
+  laptop
+}
 ```
 
 ### EXAMPLES