Skip to content

Commit 3266d2f

Browse files
author
Ryan Hoover
committed
updated readme
2 parents 8cfa8ed + 85a10e3 commit 3266d2f

File tree

1 file changed

+82
-19
lines changed

1 file changed

+82
-19
lines changed

readme.txt

Lines changed: 82 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
=== WP Engine GeoIP ===
2-
Contributors: wpengine, markkelnar, stevenkword, stephenlin, ryanshoover
2+
Contributors: wpengine, markkelnar, stevenkword, stephenlin, ryanshoover, taylor4484
33
Tags: wpe, wpengine, geoip, localization, geolocation
44
Requires at least: 3.0.1
55
Tested up to: 4.2.2
@@ -13,6 +13,7 @@ Create a personalized user experienced based on location.
1313

1414
WP Engine GeoIP integrates with the variables on your WP Engine site to display content catered to the visitor’s location. With the ability to access variables from as broad as country to as specific as latitude and longitude, your website can now display geographically relevant content.
1515

16+
1617
= Geo-Marketing =
1718

1819
* Create marketing campaigns targeted only at certain locations.
@@ -31,7 +32,7 @@ WP Engine GeoIP integrates with the variables on your WP Engine site to display
3132

3233
* Filter required legal notices from countries for whom those notices may not be relevant.
3334

34-
= ** Please Note =
35+
= * Please Note * =
3536

3637
This plugin will only function on your [WP Engine](http://wpengine.com/plans/?utm_source=wpengine-geoip) Business, Premium or Enterprise level account. This will not function outside of the WP Engine environment.
3738

@@ -40,31 +41,92 @@ This plugin will only function on your [WP Engine](http://wpengine.com/plans/?ut
4041
1. Upload `geoip` to the `/wp-content/plugins/` directory
4142
2. Activate the plugin through the 'Plugins' menu in WordPress
4243

43-
== Shortcodes ==
44+
Please view the 'Other Notes' tab to see all of the available GeoIP shortcodes
45+
46+
47+
== Location Variable Shortcodes ==
48+
You can use any of the following location variable shortcodes to return the various geographic location the user is visiting your site from:
49+
50+
1) Continent: `[geoip-continent]`
51+
52+
2) Country: `[geoip-country]`
53+
54+
3) Region (State): `[geoip-region]`
55+
56+
4) City: `[geoip-city]`
57+
58+
5) Postal Code: `[geoip-postalcode]`
59+
60+
6) Latitude: `[geoip-latitude]`
61+
62+
7) Longitutde: `[geoip-longitude]`
63+
64+
8) Location: `[geoip-location]`
65+
66+
= Example =
67+
`Hi, and welcome to [geoip-city]! The place to be in [geoip-region],[geoip-country].`
68+
A visitor from Austin, Texas would see the following:
69+
`Hi, and welcome to Austin! The place to be in TX, US.`
70+
71+
== Localized Content ==
72+
73+
9) Content: `[geoip-content country="US"]Your US specific content goes here[/geoip-content]`
74+
The content shortcode allows you to hide or show specific content based on visitor geographies:
75+
76+
Below are all the supported geography options, this allows to you SHOW content for only specific locations:
77+
78+
* continent
79+
* country
80+
* areacode
81+
* region
82+
* city
83+
* postalcode
84+
85+
Below are all the supported negative geography options, this allows to you HIDE content for only specific locations:
86+
87+
* not_continent
88+
* not_country
89+
* not_areacode
90+
* not_region
91+
* not_city
92+
* not_postalcode
93+
94+
= Examples of the Content Shortcode =
95+
This will display “Content just for US visitors” strictly for visitors viewing from the United States.
96+
`[geoip-content country="US"] Content just for US visitors [/geoip-content]`
97+
98+
99+
This will display “Content just for everyone in Texas and California” strictly for visitors from Texas and California.
100+
`[geoip-content region="TX, CA."] Content just for everyone in Texas and California [/geoip-content]`
101+
44102

45-
1) Continent: [geoip-continent]
103+
You can mix and match geography and negative geography options to create verbose logic in a single shortcode:
104+
`[geoip-content country="US" not-city="Austin"]Content for US visitors but not for visitors in Austin[/geoip-content]`
46105

47-
2) Country: [geoip-country]
48106

49-
3) Region (State): [geoip-region]
107+
== Testing Parameters ==
108+
You can use the following URL parameters to test how your localized content will appear to visitors from various geographic locations. You can add any of the parameters below to any URL of a page using the GeoIP shortcodes or API calls:
50109

51-
4) City: [geoip-city]
110+
Spoof visitor from the state of Texas:
111+
`yourdomain.com/?geoip&region=TX`
52112

53-
5) Postal Code: [geoip-postalcode]
113+
Spoof visitor from the United States:
114+
`yourdomain.com/?geoip&country=US`
54115

55-
6) Latitude: [geoip-latitude]
116+
Spoof visitor from Austin, Texas
117+
`yourdomain.com/?geoip&city=Austin`
56118

57-
7) Longitutde: [geoip-longitude]
119+
Spoof visitor from the U.S. zip code 78701:
120+
`yourdomain.com/?geoip&zip=78701`
58121

59-
8) Location: [geoip-location]
60122

61-
9) Content: [geoip-content country="US"]Your content goes here[/geoip-content]
123+
Please note: full page redirects and TLD redirects still need to be implemented with the necessary API calls.
62124

63-
== FAQ ==
125+
== Frequently Asked Questions ==
64126

65-
1) Will this work outside of a WP Engine account?
127+
1) Will this work outside of the WP Engine hosting account?
66128

67-
No, this will only work within a WP Engine environment.
129+
No, this will only work within the WP Engine environment. This will not work for sites hosted on other web hosts.
68130

69131
2) Are there any other restrictions to using this plugin?
70132

@@ -78,11 +140,11 @@ Continent, country, state, city, zip, latitude, longitude.
78140

79141
4) How do I sign up for a WP Engine Account?:
80142

81-
That’s easy! [Click here](http://wpengine.com/plans/?utm_source=wpengine-geoip).
143+
That’s easy! [Signup here](http://wpengine.com/plans/?utm_source=wpengine-geoip).
82144

83-
5) I installed the plugin and code and it isn’t working.
145+
5) I installed the plugin and used a shortcode or API call and it isn’t working.
84146

85-
Please contact the [Support Team](https://my.wpengine.com/support#general-issue).
147+
Please contact the WP Engine [Support Team](https://my.wpengine.com/support#general-issue).
86148

87149
== Screenshots ==
88150

@@ -97,7 +159,8 @@ Please contact the [Support Team](https://my.wpengine.com/support#general-issue)
97159

98160
= 1.1.0 =
99161
- Adds continent shortcode
100-
- Adds content shortcode
162+
- Adds content shortcode for localized geographic content
163+
- Adds testing parameters to spoof visitor location
101164
- Bumps version number for WP 4.2.2 compatibility
102165

103166
= 1.0.2 =

0 commit comments

Comments
 (0)