aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorFilipp Lepalaan <filipp@mac.com>2010-06-23 22:28:23 +0300
committerFilipp Lepalaan <filipp@mac.com>2010-06-23 22:28:23 +0300
commit322a983bedf3ed60027bed5d2ea28d4daea21d28 (patch)
tree0217f6fc47c8a0c0db3377dc80eb282aa780d266 /README
downloadfsfeed-master.tar.gz
fsfeed-master.tar.bz2
fsfeed-master.zip
First commitHEADmaster
Diffstat (limited to 'README')
-rw-r--r--README12
1 files changed, 12 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..dc2eecb
--- /dev/null
+++ b/README
@@ -0,0 +1,12 @@
+# Introduction #
+fsfeed is a simple PHP app that turns directory paths into Atom feeds. It's useful to run it
+on an insecure file server to notify users of file or folder updates. Users can also download
+files from their newsreader, provided that the web server has read access to the file.
+
+By using a combination of the path and modification time as the URN of an entry, it can mark
+an updated file as new in the newsreader.
+
+fsfeed is not and probably never will be, recursive.
+
+# Usage #
+Just copy the fsfeed folder to where your web server can run it from and rename fsfeed.db.default to fsfeed.db.