summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..703c58e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# fuse-httpfs
+
+python-requests based fuse read-only filesystem
+
+## Usage
+
+python3 dependencies:
+
+* requests
+* fusepy
+
+### Mount
+
+* Create a directory to be used as a mountpoint.
+* 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