markdownification of the README

This commit is contained in:
Tobias Diekershoff 2013-06-01 08:45:37 +02:00
parent 3af1c4826d
commit ea25e0a612
2 changed files with 38 additions and 34 deletions

View File

@ -1,34 +0,0 @@
Impressum Plugin for Friendica
Author: Tobias Diekershoff
http://diekershoff.homeunix.net/friendika/profile/tobias
tobias.diekershoff@gmx.net
License: 3-clause BSD license
About
This plugin adds an Impressum 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 HTML tags for formatting.
Configuration:
Simply fill in the fields in the impressium settings page in the plugins area
of your admin panel.
If you for any reason prefer to use a configuration file instead, you can set the
following variables in the .htconfig file
* $a->config['impressum']['owner'] this is the Name of the Operator
* $a->config['impressum']['ownerprofile'] this is an optional Friendica account
where the above owner name will link to
* $a->config['impressum']['email'] a contact email address (optional)
will be displayed slightly obfuscated
as name(at)example(dot)com
* $a->config['impressum']['postal'] should contain a postal address where
you can be reached at (optional)
* $a->config['impressum']['notes'] additional informations that should
be displayed in the Impressum block
* $a->config['impressum']['footer_text'] Text that will be displayed at
the bottom of the pages.

38
impressum/README.md Executable file
View File

@ -0,0 +1,38 @@
Impressum Plugin 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)
About
-----
This plugin 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..
Configuration
-------------
Simply fill in the fields in the impressium settings page in the plugins
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
--------------------
If you for any reason prefer to use a configuration file instead, you can set the following variables in the .htconfig file
$a->config['impressum']['owner'] this is the Name of the Operator
$a->config['impressum']['ownerprofile'] this is an optional Friendica account
where the above owner name will link to
$a->config['impressum']['email'] a contact email address (optional)
will be displayed slightly obfuscated
as name(at)example(dot)com
$a->config['impressum']['postal'] should contain a postal address where
you can be reached at (optional)
$a->config['impressum']['notes'] additional informations that should
be displayed in the Impressum block
$a->config['impressum']['footer_text'] Text that will be displayed at
the bottom of the pages.