Skip to content

Commit f577b70

Browse files
committed
Merge pull request #24 from wpengine/Taylor4484-update-readme
Update readme.txt
2 parents 97f2a97 + 2b17c64 commit f577b70

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

readme.txt

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ This plugin will only function on your [WP Engine](http://wpengine.com/plans/?ut
3838

3939
== Installation ==
4040

41-
1. Upload `geoip` to the `/wp-content/plugins/` directory
41+
1. Upload `wpengine-geoip` to the `/wp-content/plugins/` directory
4242
2. Activate the plugin through the 'Plugins' menu in WordPress
4343

4444
Please view the 'Other Notes' tab to see all of the available GeoIP shortcodes
@@ -51,12 +51,18 @@ You can use any of the following location variable shortcodes to return the vari
5151

5252
2) Country: `[geoip-country]`
5353

54-
3) Region (State): `[geoip-region]`
54+
3) Region: `[geoip-region]`
55+
56+
* In the US region will return States
57+
* In Canada region will return Providences
58+
* Outside the US/CA this will return a Region number. Please note region numbers are not unique between countries
5559

5660
4) City: `[geoip-city]`
5761

5862
5) Postal Code: `[geoip-postalcode]`
5963

64+
* This variable is only available in the US due to limitations with the location data GeoIP uses
65+
6066
6) Latitude: `[geoip-latitude]`
6167

6268
7) Longitutde: `[geoip-longitude]`
@@ -110,11 +116,11 @@ There is a single limitation in the logic that lets you filter content for multi
110116
You can progressively limit the area that content is shown in. But once your content is hidden from an area, a subset of that area can't be added back in.
111117

112118
For example,
113-
If I limit my image to Europe, then hide my image from Great Britain, I can't go back and show it to London.
119+
If I limit my content to Europe, then limit my content from Great Britain, I can't go back and show it to London.
114120

115-
== Creative Work Arounds and Hacks ==
121+
= Creative Work Arounds =
116122

117-
=== Limit content to some regions of a country (or some cities of a state) ===
123+
== Limit content to some regions of a country (or some cities of a state) ==
118124

119125
You want to show an offer for free shipping to every state in the US *but* Alaska and Hawaii. You may be inclined to write something like
120126

@@ -132,7 +138,7 @@ Instead, show it to all other 48 states
132138
[geoip_content state="AL, AZ, AR, CA, CO, CT, DE, FL, GA, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY"]Free shipping on all orders over $50![/geoip_content]
133139
```
134140

135-
=== Duplicate location names ===
141+
== Duplicate location names ==
136142

137143
You want to show discount airfare on a flight to Paris, France. The content should show to all of the US and France, but not Paris itself.
138144

@@ -149,7 +155,7 @@ The problem here is that Paris, Texas will be hidden. The solution? Just have tw
149155
```
150156
[geoip_content country="FR" not_city="Paris"]Fly to Paris for only $199![/geoip_content][geoip_content country="US"]Fly to Paris for only $199![/geoip_content]
151157
```
152-
=== Adding an area into an ommited region ===
158+
== Adding an area into an omitted region ==
153159

154160
You want to show an ad written in Spanish to all of South America except for Brazil. Brasilia, however, has enough Spanish speakers that you want to include Brasilia.
155161

@@ -218,6 +224,8 @@ Please contact the WP Engine [Support Team](https://my.wpengine.com/support#gene
218224
= 1.1.2 =
219225
- Fixes logic for nested parameter selectors in content shortcode
220226
- Now supports nested shortcodes. You can use shortcodes inside the [geoip-content] shortcode
227+
- Updated Documentation
228+
- Bumps version number for WP 4.3 compatibility
221229

222230
= 1.1.1 =
223231
- Fixes logic for negated parameters in content shortcode
@@ -264,5 +272,7 @@ Please contact the WP Engine [Support Team](https://my.wpengine.com/support#gene
264272

265273
== Upgrade Notice ==
266274

267-
= 1.1.1 =
268-
This version adds the following features: fixed a small issue with the content shortcode filters, allows the plugin to run on development sites. This update is recommended for all GeoIP users.
275+
= 1.1.2 =
276+
- Fixes logic for nested parameter selectors in content shortcode
277+
- Now supports nested shortcodes. You can use shortcodes inside the [geoip-content] shortcode
278+
- Updated Documentation

0 commit comments

Comments
 (0)