[TASK] Add README.md
authorAndreas Wolf <andreas.wolf@typo3.org>
Mon, 20 Apr 2015 17:14:40 +0000 (19:14 +0200)
committerAndreas Wolf <andreas.wolf@typo3.org>
Mon, 20 Apr 2015 17:14:40 +0000 (19:14 +0200)
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..69339b0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# File Abstraction Layer driver for WebDAV
+
+This extension provides the necessary interfaces to connect a TYPO3 instance to a WebDAV storage. Files can then easily
+be embedded into content or listed on the site.
+
+Encrypted communication and user authentication for WebDAV are supported.
+
+## Setup
+
+Just create a "File Storage" record (on the root page of your installation). Select "WebDAV" as the driver and fill in
+the required details.
+
+User authentication can either be done via the URL (`http://user:password@webdav.example.com/`) or in separate fields.
+In both cases, the URLs that are displayed publicly do not contain authentication information.
+
+### A note on password-protected WebDAV storages
+
+If your WebDAV requires authentication, do not mark the checkbox "Is publicly available?" in tab "Access". Otherwise,
+links will point directly to it, requiring site visitors to enter the password.
+
+In this case, you should also configure a different folder for the processed files, see setting "Folder for manipulated 
+and temporary images etc.".
+
+
+## Contact
+
+If you found a bug, create an issue on Github. If you need support or new features, drop me a line at
+`dev (at) a-w dot io`.