summaryrefslogtreecommitdiffstats
path: root/docs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 000000000..f3afcb07c
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,13 @@
+# Documentation
+
+
+As a developer you can interact with the News app in the following ways:
+
+* [Use the API for syncing and updating feeds](externalapi/)
+* [Write plugins](plugins/)
+* [Add custom CSS for feeds](feedcss/)
+* [Customize the explore section](explore/)
+
+
+The News app uses [picoFeed](https://github.com/fguillot/picoFeed) for parsing feeds and full text feeds. picoFeed is a fantastic library so if you [add custom full text configurations](https://github.com/fguillot/picoFeed/blob/master/docs/grabber.markdown#how-to-write-a-grabber-rules-file) or fix bugs, please consider **contributing your changes** back to the library to help others :)
+