]> git.mxchange.org Git - friendica-addons.git/commitdiff
Update multiple README.md
authorHypolite Petovan <mrpetovan@gmail.com>
Thu, 28 Jun 2018 13:40:20 +0000 (09:40 -0400)
committerHypolite Petovan <mrpetovan@gmail.com>
Tue, 10 Jul 2018 12:41:31 +0000 (08:41 -0400)
- Update geonames, impressum, piwik, public_server, testdrive, twitter

geonames/README.md [new file with mode: 0644]
impressum/README.md
piwik/README.md
public_server/README.md
testdrive/README.md
twitter/README.md

diff --git a/geonames/README.md b/geonames/README.md
new file mode 100644 (file)
index 0000000..83f9c69
--- /dev/null
@@ -0,0 +1,15 @@
+Geonames Addon
+==============
+
+Authors Mike Macgirvin.
+
+Use Geonames service to resolve nearest populated location for given latitude, longitude.
+
+## Installation
+
+Pre-requisite: Register a username at geonames.org and set in config/local.ini.php
+
+    [geonames]
+    username = your_username
+
+Also visit http://geonames.org/manageaccount and enable access to the free web services.
\ No newline at end of file
index 1dde2ac3c30b1a642d8328a4a5b91934c9ea4657..65ec454774023162d91c267804ad964dcb5a55f0 100644 (file)
@@ -2,23 +2,17 @@ Impressum Addon for Friendica
 ==============================
 
 * Author: Tobias Diekershoff
-* License: [3-clause BSD](http://opensource.org/licenses/BSD-3-Clause) license
-  (see the LICENSE file in the addon directory)
+* License: [3-clause BSD](http://opensource.org/licenses/BSD-3-Clause) license (see the LICENSE file in the addon directory)
 
 About
 -----
-This addon adds an Impressum (contact) block to the /friendica page with
-informations about the page operator/owner and how to contact you in case of
-any questions.
+This addon adds an Impressum (contact) block to the /friendica page with informations about the page operator/owner and how to contact you in case of any questions.
 
-In the notes and postal fields you can use bbcode tags for formatting, like in
-normal friendica postings..
+In the notes and postal fields you can use bbcode tags for formatting, like in normal friendica postings..
 
 Configuration
 -------------
-Simply fill in the fields in the impressium settings page in the addons
-area of your admin panel. For email adresses the "@" symbol will be obfuscated
-in the source of the page to make in harder for harvesting tools.
+Simply fill in the fields in the impressium settings page in the addons area of your admin panel. For email adresses the "@" symbol will be obfuscated in the source of the page to make in harder for harvesting tools.
 
 Manual Configuration
 --------------------
index eb3dc39d1db8f7580954deaa42da7465f1f06ade..08fabe661e351709b63a0bd16e071101b18dbff1 100644 (file)
@@ -3,8 +3,7 @@ Piwik Addon
 
 by Tobias Diekershoff and Klaus Weidenbach
 
-This addon allows you to embed the code necessary for the FLOSS webanalytics
-tool Piwik into the Friendica pages.
+This addon allows you to embed the code necessary for the FLOSS webanalytics tool Piwik into the Friendica pages.
 
 Requirements
 ------------
@@ -14,18 +13,14 @@ To use this addon you need a [piwik](http://piwik.org/) installation.
 Where to find
 -------------
 
-In the Friendica addon git repository `/piwik/piwik.php` and a CSS file for
-styling the opt-out notice.
+In the Friendica addon git repository `/piwik/piwik.php` and a CSS file for styling the opt-out notice.
 
 Configuration
 -------------
 
-The easiest way to configure this addon is by activating the admin panels of
-your ~friendica server and then enter the needed details on the config page
-for the addon.
+The easiest way to configure this addon is by activating the admin panels of your ~friendica server and then enter the needed details on the config page for the addon.
 
-If you don't want to use the admin panel, you can configure the addon through
-the config/local.ini.php file.
+If you don't want to use the admin panel, you can configure the addon through the config/local.ini.php file.
 
 Open the config/local.ini.php file and add "piwik" to the list of activated addons.
 
@@ -43,28 +38,19 @@ You can change 4 more configuration variables for the addon:
 Configuration fields
 ---------------------
 
-* The *baseurl* points to your Piwik installation. Use the absolute path,
-remember trailing slashes but ignore the protocol (http/s) part of the URL.
-* Change the *sideid* parameter to whatever ID you want to use for tracking your
-Friendica installation.
-* The *optout* parameter (true|false) defines whether or
-not a short notice about the utilization of Piwik will be displayed on every
-page of your Friendica site (at the bottom of the page with some spacing to the
-other content). Part of the note is a link that allows the visitor to set an
-_opt-out_ cookie which will prevent visits from that user be tracked by piwik.
-* The *async* parameter (true|false) defines whether or not to use asynchronous
-tracking so pages load (or appear to load) faster.
+* The *baseurl* points to your Piwik installation. Use the absolute path, remember trailing slashes but ignore the protocol (http/s) part of the URL.
+* Change the *sideid* parameter to whatever ID you want to use for tracking your Friendica installation.
+* The *optout* parameter (true|false) defines whether or not a short notice about the utilization of Piwik will be displayed on every page of your Friendica site (at the bottom of the page with some spacing to the
+other content). Part of the note is a link that allows the visitor to set an _opt-out_ cookie which will prevent visits from that user be tracked by piwik.
+* The *async* parameter (true|false) defines whether or not to use asynchronous tracking so pages load (or appear to load) faster.
 
 Currently the optional notice states the following:
 
->    This website is tracked using the Piwik analytics tool. If you do not want
->    that your visits are logged this way you can set a cookie to prevent Piwik
->    from tracking further visits of the site (opt-out).
+>    This website is tracked using the Piwik analytics tool. If you do not want that your visits are logged this way you can set a cookie to prevent Piwik from tracking further visits of the site (opt-out).
 
 License
 =======
 
-The _Piwik addon_ is licensed under the [3-clause BSD license][3] see the
-LICENSE file in the addons directory.
+The _Piwik addon_ is licensed under the [3-clause BSD license][3] see the LICENSE file in the addons directory.
 
 [3]: http://opensource.org/licenses/BSD-3-Clause
index bd297424547dcec762595dc81ab7fb4350cbf842..02151478da7d5c1cf158c3cda95edccc666c51a1 100644 (file)
@@ -2,8 +2,7 @@ Public Server
 =============
 
 
-Public Server is a Friendica addon which implements automatic account & post expiration so that a site may be used as a public
-test bed with reduced data retention.
+Public Server is a Friendica addon which implements automatic account & post expiration so that a site may be used as a public test bed with reduced data retention.
 
 This is a modified version of the testdrive addon, DO NOT ACTIVATE AT THE SAME TIME AS THE TESTDRIVE ADDON.
 
@@ -26,5 +25,5 @@ The default values are those used by friendica.eu, change these as desired.
 
 The expiration date is updated when the user logs in.
 
-An email warning will be sent out approximately five days before the expiration occurs. Five days later the account is removed completely.
-
+An email warning will be sent out approximately five days before the expiration occurs.
+Five days later the account is removed completely.
index a880cc86dafb352288644f64370dc2c56e5f4bdd..fc95918bcec82cad8fa9e8b1ac59e91c83c21b1f 100644 (file)
@@ -2,21 +2,21 @@ TestDrive
 =========
 
 
-Testdrive is a Friendica addon which implements automatic account expiration so that a site may be used as a public
-test bed.
+Testdrive is a Friendica addon which implements automatic account expiration so that a site may be used as a public test bed.
 
 When an account is created on the site, it is given a hard expiration date of
 
        [testdrive]
        expiredays = 30
 
-Set this in your config/local.ini.php file to allow a 30 day test drive period. By default no expiration period is defined
-in case the addon is activated accidentally.
+Set this in your config/local.ini.php file to allow a 30 day test drive period.
+By default no expiration period is defined in case the addon is activated accidentally.
 
+There is no opportunity to extend an expired account using this addon.
+Expiration is final.
+Other addons may be created which charge for service and extend the expiration as long as a balance is maintained.
+This addon is purely for creating a limited use test site.
 
-There is no opportunity to extend an expired account using this addon. Expiration is final. Other addons may be created
-which charge for service and extend the expiration as long as a balance is maintained. This addon is purely for creating
-a limited use test site.
-
-An email warning will be sent out approximately five days before the expiration occurs. Once it occurs logins and many
-system functions are disabled. Five days later the account is removed completely.
+An email warning will be sent out approximately five days before the expiration occurs.
+Once it occurs logins and many system functions are disabled.
+Five days later the account is removed completely.
index 5a48869007148fa3610e5fae4b8c9fcf4ab47185..7eaef8f43876499eed43826c3d023efb6eda6bb8 100644 (file)
@@ -3,16 +3,28 @@ Twitter Addon
 
 Main authors Tobias Diekershoff, Michael Vogel and Hypolite Petovan.
 
-This bi-directional connector addon allows each user to crosspost their Friendica public posts to Twitter, import their
-Twitter timeline, interact with tweets from Friendica, and crosspost to Friendica their public tweets.
+This bi-directional connector addon allows each user to crosspost their Friendica public posts to Twitter, import their Twitter timeline, interact with tweets from Friendica, and crosspost to Friendica their public tweets.
 
 ## Installation
 
 To use this addon you have to register an [application](https://apps.twitter.com/) for your Friendica instance on Twitter.
+Register your Friendica site as "Client" application with "Read & Write" access we do not need "Twitter as login".
 Please leave the field "Callback URL" empty.
+When you've registered the app you get the OAuth Consumer key and secret pair for your application/site.
 
 After the registration please enter the values for "Consumer Key" and "Consumer Secret" in the [administration](admin/addons/twitter).
 
+## Alternative configuration
+
+Add your key pair to your global config/local.ini.php.
+
+    [twitter]
+    consumerkey = your consumer_key here
+    consumersecret = your consumer_secret here
+
+To activate the addon itself add it to the [system] addon setting.
+After this, users can configure their Twitter account settings from "Settings -> Addon Settings".
+
 ## License
 
 The _Twitter Connector_ is licensed under the [3-clause BSD license][2] see the LICENSE file in the addons directory.