Skip to content

Commit

Permalink
Update documentation and version
Browse files Browse the repository at this point in the history
  • Loading branch information
alwaysblank committed Jun 21, 2018
1 parent f3129c8 commit 925f8f2
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 11 deletions.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).
**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');
// <a href="/posts/a-post-you-linked-to" class="field-class class-the-user-set">Link Text!</a>
```
8 changes: 4 additions & 4 deletions acf-zelda.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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__ )
);
Expand All @@ -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
Expand Down
9 changes: 4 additions & 5 deletions readme.txt
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -28,5 +27,5 @@ This ACF field type is compatible with:

== Changelog ==

= 1.0.0 =
* Initial Release.
= 0.0.1 =
* Initial functionality. Not recommended for production use.

0 comments on commit 925f8f2

Please sign in to comment.