aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/README.md b/README.md
index 97d30ce..17fd76b 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,18 @@
-# fbrss
+# fbfeed
Web scraper that presents a public Facebook group's post as an RSS
-feed.
+feed or HTML page.
This is particular good for those of you who do not use Facebook,
but still end up in social networks and local communities where
gatherings and events are all organized using Facebook.
+
+## Usage
+
+Compile and run. Host it somewhere or locally.
+
+For HTML: `/nameOfGroup`
+
+For RSS: `/nameOfGroup.rss`
+
+`nameOfGroup` is the @-name in Facebook.