summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Baumann <mail@andreasbaumann.cc>2018-06-05 21:13:40 +0200
committerAndreas Baumann <mail@andreasbaumann.cc>2018-06-05 21:13:40 +0200
commit981f29e2bce029463ce6e22cdf5fade3e9c07a0f (patch)
tree5c502bc490559855b0f0a3d151a24503be4b0a3c
parentc07514affe3f64ebc7200f3136a2125893abbcdd (diff)
downloadpgfuse-981f29e2bce029463ce6e22cdf5fade3e9c07a0f.tar.gz
pgfuse-981f29e2bce029463ce6e22cdf5fade3e9c07a0f.tar.bz2
updated README
-rw-r--r--README52
1 files changed, 27 insertions, 25 deletions
diff --git a/README b/README
index b2c5be1..59a900b 100644
--- a/README
+++ b/README
@@ -1,17 +1,14 @@
-Purpose
--------
+## Purpose
Store files and their metadata completely in a PostgreSQL database.
Expose a standard file system with the help of the FUSE API.
-Requirements
-------------
+## Requirements
-PostgreSQL 8.4 or newer
-FUSE 2.6 or newer
+- PostgreSQL 8.4 or newer
+- FUSE 2.6 or newer
-History
--------
+## History
Yes, I know what happens if you store files in a database (in respect to
drop of efficiency and incremental backups for instance). :-)
@@ -29,31 +26,36 @@ Most other projects try to map an existing database structure somehow as
files. This here should strictly deal withs files/dirs as the only
available model.
-Other projects
---------------
+## Other projects
-Pgfs:
+### Pgfs:
- Stores a filesystem in Postgres, exposes it as a NFS server, rather old
- and I was unable to find the sources.
+Stores a filesystem in Postgres, exposes it as a NFS server, rather old
+and I was unable to find the sources.
-mysqlfs:
+### mysqlfs
- The blueprint I used and got inspired from. Does exactly the same for
- the MySQL database.
+The blueprint I used and got inspired from. Does exactly the same for
+the MySQL database.
- Also the block splitting algorithm I used more or less from this project.
+ Also the block splitting algorithm I used more or less from this project.
-libsqlfs:
+### libsqlfs
- The same for storing files in a Sqlite database.
+The same for storing files in a Sqlite database.
-curlftpfs:
+### curlftpfs
- Blueprint for some debugging code.
+Blueprint for some debugging code.
-References
-----------
+## References
-http://www.postgresql.org/docs/
-http://fuse.sourceforge.net/
+- http://www.postgresql.org/docs/
+- http://fuse.sourceforge.net/
+
+A Git repository is accessible at
+**git://git.andreasbaumann.cc/pgfuse.git**
+(or at http://git.andreasbaumann.cc/cgit/pgfuse/)
+
+In case of questions, if you want to supply a patch or if you
+want to collaborate on the project contact me via email.