Merge pull request 'Bluesky: Provide the correct user id while fetching content'...

[friendica-addons.git] / README.md

diff --git a/README.md b/README.md
index 162f368e47ba91b62345d8d272b869644654bfa0..6a3202bb885435c220500f0037515498287aa7b9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,29 @@
-# frio-hovercard
-friendica hovercard addon for the frio theme
+Addons for Friendica
+====================
+
+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.
+
+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.
+
+## Issues
+
+Please report any issues you have with addons of Friendica from this repository in [the main issue tracker of the project](https://github.com/friendica/friendica/issues).
+
+## Connectors
+
+Among these addons there are also the [connectors](https://github.com/friendica/friendica/blob/stable/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/stable/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/stable/doc/translations.md#addon).