From af44b8c3c05f24e04e95cde2e48718bea4702b3c Mon Sep 17 00:00:00 2001 From: "info@mschuette.name" Date: Wed, 2 Apr 2014 18:54:57 +0000 Subject: [PATCH] add example and licence file --- LICENCE | 24 ++++++++++++++++++++++++ README.md | 18 ++++++++++++++++++ 2 files changed, 42 insertions(+) create mode 100644 LICENCE diff --git a/LICENCE b/LICENCE new file mode 100644 index 0000000..6fac106 --- /dev/null +++ b/LICENCE @@ -0,0 +1,24 @@ +Copyright (c) 2014, Martin Schuette +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. + +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 THE COPYRIGHT HOLDER OR CONTRIBUTORS 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. + diff --git a/README.md b/README.md index d4b024f..5007d92 100644 --- a/README.md +++ b/README.md @@ -6,4 +6,22 @@ It reads (and caches) JSON input from a configured URL and provides shortcodes t Currently implemented are `[ff_services]` and `[ff_contact]`. +## Example +Text: + + Services: + + [ff_services] + + Contact: + + [ff_contact] + + Contact Jena: + + [ff_contact url="http://freifunk-jena.de/jena.json"] + +Output: + +![shortcode output example](http://mschuette.name/wp/wp-upload/freifunk_meta_example.png)