Merge pull request #125 from tobiasd/impressum

Impressum: markdownification of the README

impressum/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2011-2013 Tobias Diekershoff
+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.

impressum/README

@@ -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.

impressum/README.md

@@ -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.