summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-06-03 17:18:19 +0200
committerLoïc Hoguin <[email protected]>2013-06-03 17:18:19 +0200
commit4b13eb4bc64d7f04291fcb62ee4794a672d8d3b5 (patch)
tree1ca4370366e49d163d4528fee493775c4283a9ca /README.md
parent03a27991428d3510f9ef6ff53a3bd7347a3831b4 (diff)
downloadct_helper-4b13eb4bc64d7f04291fcb62ee4794a672d8d3b5.tar.gz
ct_helper-4b13eb4bc64d7f04291fcb62ee4794a672d8d3b5.tar.bz2
ct_helper-4b13eb4bc64d7f04291fcb62ee4794a672d8d3b5.zip
Add create_static_dir/1 and delete_static_dir/1
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
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
---------------------------