summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..de8aee1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+fuse-httpfs
+===========
+
+python-requests based fuse read-only filesystem
+
+Requirements
+------------
+
+* fusepy
+
+* requests
+* fusepy
+
+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