Browse Source

Merge pull request #127 from tobiasd/markdownify

Markdownify the READMEs of blackout, piwik, webrtc
pull/128/head^2
Tobias Diekershoff 9 years ago
parent
commit
309f058b15
  1. 19
      blackout/LICENSE
  2. 19
      blackout/README.md
  3. 24
      piwik/LICENSE
  4. 47
      piwik/README.md
  5. 10
      webrtc/README.md

19
blackout/LICENSE

@ -0,0 +1,19 @@
Copyright (c) 2012 Tobias Diekershoff
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

19
blackout/README → blackout/README.md

@ -1,11 +1,12 @@
Name: blackout
Description: Blackout your ~friendica node during a given period
License: MIT
Version: 1.0
Author: Tobias Diekershoff <https://diekershoff.homeunix.net/friendika/~tobias>
blackout addon
==============
* Description: Blackout your ~friendica node during a given period
* License: [MIT](http://opensource.org/licenses/MIT)
* Version: 1.0
* Author: Tobias Diekershoff
About
=====
-----
This plugin will allow you to enter a date/time period during which
all your ~friendica visitors from the web will be redirected to a page
@ -21,12 +22,12 @@ the entered time periode and fix typos without having to hack the
database directly.
Requirements
============
-------------
THIS ADDON REQUIRES PHP VERSION 5.3 OR HIGHER.
**THIS ADDON REQUIRES PHP VERSION 5.3 OR HIGHER.**
License
=======
-------
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

24
piwik/LICENSE

@ -0,0 +1,24 @@
Copyright (c) 2011-2013 Tobias Diekershoff, Klaus Weidenbach
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the distribution.
* Neither the name of the <organization> nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

47
piwik/README → piwik/README.md

@ -1,24 +1,24 @@
## Piwik Plugin ##
Piwik Plugin
============
by Tobias Diekershoff
http://diekershoff.homeunix.net/friendika/profile/tobias
tobias.diekershoff(at)gmx.net
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.
[Online version of this Document](http://ur1.ca/35m2x)
### Requirements ###
Requirements
------------
To use this plugin you need a [piwik](http://piwik.org/) installation.
### Where to find ###
Where to find
-------------
In the Friendica git repository `/addon/piwik/piwik.php` and a CSS file for
In the Friendica addon git repository `/piwik/piwik.php` and a CSS file for
styling the opt-out notice.
### Configuration ###
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
@ -38,20 +38,31 @@ You have to add 4 more configuration variables for the addon:
$a->config['piwik']['optout'] = true;
$a->config['piwik']['async'] = false;
The *baseurl* points to your Piwik installation. Use the absolute path,
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
* 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).
The *async* parameter (true|false) defines whether or not to use asynchronous
tracking so pages load (or appear to load) faster.
License
=======
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

10
webrtc/README → webrtc/README.md

@ -1,7 +1,7 @@
Webrtc Plugin
====================
WebRTC Plugin
=============
This is a quick and dirty addon to add a webrtc website as an app. As webrtc
This is a quick and dirty addon to add a [webrtc][1] website as an app. As webrtc
advances so rapidly there is s a chance this plugin will be obsolete. Webrtc is
a new video and audio conferencing tool that is browser to browser
communication, no need to download specific software for just conferencing.
@ -12,7 +12,7 @@ between the participants.
If you would like to try this plugin please download one of the following
either Chrome/Chromium 25 or higher or Firefox 21 or higher. Then test it by
visiting a known webrtc instance (i.e. https://live.mayfirst.org) create a
visiting a known webrtc instance (i.e. [live.mayfirst.org](https://live.mayfirst.org)) create a
room, you should be asked to share your camera and microphone (firefox will let
you choose one or the other, whereas chrome/chromium asks for both in one
question).
@ -20,3 +20,5 @@ question).
If the test is successful then proceed with copying the webrtc instance you
would like to use and place it in the config window and save. Now when you
opent he app it will load the webrtc instance for you to use.
[1]: https://en.wikipedia.org/wiki/WebRTC
Loading…
Cancel
Save