Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Added README and License

  • Loading branch information...
commit 825c509dfb13ec47e504d246b43ac5e94b6be93f 1 parent 6a5fe75
@aslakhellesoy authored
Showing with 73 additions and 0 deletions.
  1. +20 −0 License.txt
  2. +53 −0 README.textile
View
20 License.txt
@@ -0,0 +1,20 @@
+Copyright (c) 2009 Aslak Hellesøy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
53 README.textile
@@ -0,0 +1,53 @@
+h1. WebDav.js
+
+This is a simple JavaScript library that attempts to implement a subset of the
+WebDav standard. It (currently) doesn't aim to be complete - just support basic
+operations.
+
+WebDav.js has a low-level API (the WebDav object) and a higher level, more OO API
+(WebDav.Fs).
+
+Both APIs can operate in synchronous and asynchronous mode: All functions that
+declare a callback argument accept an optional function. If a callback function is
+passed, the HTTP request will happen asynchronously, passing the result to that
+function. If no callback function is passed, the result is returned directly after
+the synchronous HTTP request.
+
+For each function - "result" refers to either the function's return value or the
+argument passed to the callback function (if any).
+
+h2. WebDav
+
+This is a very thin wrapper around XMLHttpRequest.
+
+h2. WebDav.Fs
+
+This is probably what you want to use. This object has two functions:
+
+* WebDav.Fs.dir(url) - returns a Dir object
+* WebDav.Fs.file(url) - returns a File object
+
+h3. File.read(callback)
+
+Reads the file and passes the contents to the result.
+
+h3. File.write(data, callback)
+
+Writes data to the file.
+
+h3. File.rm()
+
+Deletes the file.
+
+h3. Dir.children()
+
+Lists all files and directories under Dir. The result is an Array of other File
+and/or Dir objects.
+
+h3. Dir.mkdir()
+
+Creates the directory.
+
+h3. Dir.rm()
+
+Removes the directory.
Please sign in to comment.
Something went wrong with that request. Please try again.