From 925f8f22b8ec18b881601bc75e6fca695932d43c Mon Sep 17 00:00:00 2001 From: Ben Martinez-Bateman Date: Wed, 20 Jun 2018 20:34:30 -0700 Subject: [PATCH] Update documentation and version --- README.md | 26 ++++++++++++++++++++++++-- acf-zelda.php | 8 ++++---- readme.txt | 9 ++++----- 3 files changed, 32 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 6be6104..4b96a0c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,25 @@ -# ACF Zelda Field +# 👸 Zelda -I don't want to store URLs for local content in the database: Neither do you. This allows you to store links to any kind of content in a better, safer way. It also allows you to define a bit of link metadata (i.e. title, target, etc). \ No newline at end of file +**A more useful Link** + +I don't want to store URLs for local content in the database: Neither do you. This allows you to store links to any kind of content in a better, safer way. It also allows you to define a bit of link metadata (i.e. text, target, etc). + +## Features + +- Select the content and taxonomy types *you* want to link to! +- *Never* store URLs in the database (all links are created at page-load)! + - Well, except for `external` links, which are URLs by definition. +- Filter *everything* (**future release**) +- Add your own link types on the fly (**future release**) + +## Usage + +It's just a WordPress plugin, so plug it in! + +Once you've done that, just add a Zelda field and then call it in your template like you'd do with any other ACF field: + +```php +// page-template.php +the_field('example_zelda_field'); +// Link Text! +``` diff --git a/acf-zelda.php b/acf-zelda.php index de00281..2729df2 100644 --- a/acf-zelda.php +++ b/acf-zelda.php @@ -4,7 +4,7 @@ Plugin Name: Advanced Custom Fields: Zelda Plugin URI: https://github.com/alwaysblank/zelda Description: More flexible, less fragile: Better link selection. -Version: 0.0.1-alpha +Version: 0.0.1 Author: Ben Martinez-Bateman Author URI: https://www.alwaysblank.org License: GPLv2 or later @@ -33,7 +33,7 @@ class livy_acf_plugin_zelda { * * @type function * @date 17/02/2016 - * @since 1.0.0 + * @since 0.0.1 * * @param void * @return void @@ -44,7 +44,7 @@ function __construct() { // settings // - these will be passed into the field class. $this->settings = array( - 'version' => '1.0.0', + 'version' => '0.0.1', 'url' => plugin_dir_url( __FILE__ ), 'path' => plugin_dir_path( __FILE__ ) ); @@ -63,7 +63,7 @@ function __construct() { * * @type function * @date 17/02/2016 - * @since 1.0.0 + * @since 0.0.1 * * @param $version (int) major ACF version. Defaults to 4 * @return void diff --git a/readme.txt b/readme.txt index 2bb4266..4501094 100644 --- a/readme.txt +++ b/readme.txt @@ -1,9 +1,8 @@ === Advanced Custom Fields: Zelda Field === Contributors: Ben Martinez-Bateman Tags: acf, wordpress, link -Requires at least: 3.6.0 -Tested up to: 4.9.0 -Stable tag: trunk +Requires at least: 4.0.0 +Tested up to: 0.0.0 License: GPLv2 or later License URI: http://www.gnu.org/licenses/gpl-2.0.html @@ -28,5 +27,5 @@ This ACF field type is compatible with: == Changelog == -= 1.0.0 = -* Initial Release. \ No newline at end of file += 0.0.1 = +* Initial functionality. Not recommended for production use. \ No newline at end of file