Fixing rendertime
[friendica-addons.git/.git] / README.md
index db22a32..08451b6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,15 +1,27 @@
-# frio-hovercard
-friendica hovercard addon for the frio theme
+Addons for Friendica
+====================
 
-This addon provides a hovercard for firendicas frio theme.
+This repository is a collection of addons for the [Friendica Social Communications Server](https://github.com/friendica/friendica).
+You can add these addons to the /addon directory of your Friendica installation do extend the functionality of your node.
 
-**It not intended to use the plugin without the frio theme or vice versa.**
+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.
 
-It's a sample implementation how friendica could provide json userdata for
-the hovercard. Ideally we should implement something like a profile data api endpoint like 
-it is done in diaspora & gnu social. This would search at the foreign server for the requested data.
-We could also think about supporting requesting the api of diaspora  and gnu social.
+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.
 
-At the present state the data comes from the own contact and gcontact table
+## Connectors
 
-[original commit history](https://github.com/rabuzarus/frio_hovercard/commits/master)
+Among these addons 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 protocol 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/Addons.md) for more information on the addon development.
+
+## Translation
+
+Addons can be translated like any other part of Friendica.
+Translation for addons is done at [the Transifex Friendica page](https://www.transifex.com/Friendica/friendica/dashboard/).
+
+Read more about the workflow in the [Friendica translation documentation](https://github.com/friendica/friendica/blob/master/doc/translations.md#addon).