updated Install.txt and added REDME.md

[friendica-addons.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..84f17de
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+Addons for Friendica
+====================
+
+This repository is a collection of plugins for the [Friendica Social Communications Server](https://github.com/friendica/friendica).
+You can add these plugins to the /addon directory of your Friendica installation
+do extend the functionality of your node.
+
+After uploading the addons to your server, you need to activate the desired addons
+in the Admin panel. Addons not activated have no effect on your node.
+
+You can find more addons in the [Friendica Addon listing](https://addons.friendo.ca)
+in cases the addon developers have choosen not to include them here.
+
+Connectors
+----------
+
+Among these plugins there are also the [connectors](https://github.com/friendica/friendica/blob/master/doc/Connectors.md) for various other networks
+(e.g. Twitter, pump.io, Google+) that are needed for communication when the
+protocoll is not supported by Friendica core (DFRN, OStatus and Diaspora).
+
+For communication with contacts in networks supporting those (e.g. GNU social,
+Diaspora and red#matrix) you just need to access the page configuration in the
+Admin panel and enable them. For networks where communication is only possible
+the API access to a remote account, you need to activate the fitting connectors.
+
+Development
+-----------
+
+The addon interface of Friendica is very flexible and powerful, so if you are
+missing functionality, your chances are high it may be added with an addon.
+See the [documentation](https://github.com/friendica/friendica/blob/master/doc/Plugins.md) for more informations on the plugin development.