From 4b13eb4bc64d7f04291fcb62ee4794a672d8d3b5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Mon, 3 Jun 2013 17:18:19 +0200
Subject: Add create_static_dir/1 and delete_static_dir/1

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

(limited to 'README.md')

diff --git a/README.md b/README.md
index c67e570..58a68a9 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,29 @@ ct_helper
 
 Helper modules for common_test suites.
 
+Creating temporary static files
+-------------------------------
+
+This library includes a function that will generate files tailored
+for testing web servers. The following snippet will create a
+directory containing all the files and subsequently delete it all.
+
+``` erlang
+ct_helper:create_static_dir(Path),
+%% do things!
+ct_helper:delete_static_dir(Path).
+```
+
+The following files are created. Replace `./` with the `Path` passed
+as argument to find the real path of the files.
+
+ *  ./
+ *  ./directory/
+ *  ./unknown
+ *  ./style.css
+ *  ./index.html
+ *  ./unreadable (mode 0333)
+
 Generating SSL certificates
 ---------------------------
 
-- 
cgit v1.2.3