README.adoc: mention full file content is sent to remote

[safcm/safcm.git] / README.adoc

diff --git a/README.adoc b/README.adoc
index 2512596957b7ba0b6efb1c191ac84ed0c913a005..7148a2094a6b69b6c37b7fee5ec0e06d7bcb9bfd 100644 (file)
--- a/README.adoc
+++ b/README.adoc
@@ -102,6 +102,15 @@ future, others are due to the design of safcm.
   `/root` which often have strict permissions by default, so carefully check
   the diff output for unwanted changes.
 
+- Full file content of all files is sent to the remote during synchronization.
+  This makes it impractical to synchronize large files with safcm. As most
+  configuration files are small this shouldn't be an issue for common
+  scenarios.
+
+- Quoted strings in the output are quoted using Go's `%q` format string. The
+  result is similar -- but not identical -- to quoted strings in regular shell
+  scripts which can be confusing.
+
 
 == Requirements