From d2523d7b6cd5420b86c00dea6ec8e7fd7cf58851 Mon Sep 17 00:00:00 2001
From: Solene Rapenne <solene@perso.pw>
Date: Mon, 14 Mar 2022 18:44:31 +0100
Subject: [PATCH] documentation: explain file configuration format

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/README.md b/README.md
index eb6df9e..d32d594 100644
--- a/README.md
+++ b/README.md
@@ -31,6 +31,32 @@ The configuration file describes the size of the memory filesystem,
 the list of files and the list of directories that should be added
 to the filesystem as symbolic links from the persistent directory.
 
+There are currently three keys:
+- **size**: which is a parameter to mount_mfs -s to give the ramdisk size
+- **files**: which is a list of files relative to $HOME
+- **directores**: which is a list of directories relative to $HOME
+
+Minimalistic example of `/home/persist/my-user/impermanence.yml`:
+
+```
+size: 200m
+files:
+  - .bashrc
+  - .gitconfig
+  - .profile
+  - .tmux.conf
+  - .xsession
+directories:
+  - .config
+  - .local/share
+  - .mozilla
+  - .ssh
+  - Data
+  - Documents
+  - Downloads
+  - dev
+```
+
 # home-impermanence rc service
 
 ## restart