summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..bba5554
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,30 @@
+===========
+fuse-httpfs
+===========
+
+python-requests based fuse read-only filesystem
+
+Usage
+-----
+
+### Setup
+
+Create a directory to be used as a mountpoint.
+
+### Starting
+
+run with --help
+
+### Using
+
+* access the mountpoint
+* open directory for schema (http/https)
+* open an (maybe non-existing) directoring with the desired hostname
+
+
+Remote machines configure in ~/.netrc will appear automatically. python-requests will pick-up the authentication infos from .netrc
+
+
+## Run the tests
+
+ python3.4 -m unittest test