Skip to content

Commit eab8c3c

Browse files
Update readme
1 parent c16ce29 commit eab8c3c

File tree

1 file changed

+35
-54
lines changed

1 file changed

+35
-54
lines changed

readme.txt

Lines changed: 35 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -12,59 +12,54 @@ Flexible call to action boxes, popping up or sliding in at just the right time.
1212

1313
== Description ==
1414

15-
= Call-To-Action Boxes =
15+
### Boxzilla for WordPress
1616

1717
Boxzilla is a *lightweight* plugin for adding flexible call-to-actions to your WordPress site. Boxes can slide or fade in at any point and can contain whatever content you like.
1818

19-
= Features =
20-
21-
- Create boxes containing whatever content you like: shortcodes, links, custom HTML, anything really.
22-
- Show boxes automatically after scrolling down based on a percentage point or a certain element (like your comment section).
23-
- Show boxes using a button or link.
24-
- Choose the box position: centered or in any corner of the screen.
25-
- Choose between a fading or sliding animation for showing the box.
26-
- Customize the box appearance using a few simple color & dimension controls.
27-
- Only load the box on certain pages, posts, etc.
28-
- Control how long dismissed boxes should stay hidden.
29-
- Control whether boxes should show on small screens.
19+
#### Some of Boxzilla's features
20+
21+
- Boxes can contain _any_ content you like.
22+
- Various box triggers:
23+
- Scroll percentage
24+
- Reaching a certain page element
25+
- X amount of time on the page
26+
- Exit Intent (premium)
27+
- Time on Site (premium)
28+
- Manually by clicking a link or button
29+
- Customizable box position on the screen.
30+
- Various visibility animations.
31+
- Advanced page targeting.
32+
- Full control over how long (and whether) boxes should stay hidden.
33+
- Customizable box appearance using a simple & intuitive interface.
34+
- Mobile optimized.
3035

3136
[Read more about Boxzilla](https://boxzillaplugin.com/#utm_source=wp-plugin-repo&utm_medium=boxzilla&utm_campaign=description).
3237

33-
= Documentation =
38+
#### Documentation
3439

35-
Please have a look at the [frequently asked questions](https://wordpress.org/plugins/boxzilla/faq/).
40+
Please have a look at the [Boxzilla KB](https://kb.boxzillaplugin.com/).
3641

37-
= Demo =
42+
#### Demo
3843

39-
There's a [Boxzilla demo site](https://demo.boxzillaplugin.com#utm_source=wp-plugin-repo&utm_medium=boxzilla&utm_campaign=description), showcasing the vast amount of possibilities for you to gather your leads.
44+
There's a [Boxzilla demo](https://demo.boxzillaplugin.com#utm_source=wp-plugin-repo&utm_medium=boxzilla&utm_campaign=description) with some examples.
4045

41-
= Add-ons =
46+
#### Add-on plugins
4247

43-
The core Boxzilla plugin is free and always will be. Additional advanced functionality is available through several add-ons. Not only do they extend the core functionality of the plugin, they also help to fund further development of the core (free) plugin.
48+
The core Boxzilla plugin is and always will be free. Additional advanced functionality is available through several add-ons. Not only do they extend the core functionality of the plugin, they also help to fund further development of the core (free) plugin.
4449

4550
[Browse available add-ons for Boxzilla](https://boxzillaplugin.com/add-ons/#utm_source=wp-plugin-repo&utm_medium=boxzilla&utm_campaign=description).
4651

47-
Some popular add-ons include:
48-
49-
**[Theme Pack](https://boxzillaplugin.com/add-ons/theme-pack#utm_source=wp-plugin-repo&utm_medium=boxzilla&utm_campaign=description)**
50-
51-
A set of beautiful plug & play themes which make your boxes really stand out.
52-
53-
**[MailChimp for WordPress](https://mc4wp.com/)**
54-
55-
An easy way to show a MailChimp sign-up form inside your boxes.
52+
#### Contributing and reporting bugs=
5653

57-
= Contributing and reporting bugs =
54+
You can contribute to [Boxzilla on GitHub](https://github.com/ibericode/boxzilla).
5855

59-
You can contribute to this plugin using GitHub: [ibericode/boxzilla](https://github.com/ibericode/boxzilla)
60-
61-
= Support =
56+
#### Support
6257

6358
Please use the [WordPress.org plugin support forums](https://wordpress.org/support/plugin/boxzilla) for community support where we try to help all users.
6459

6560
If you think you've found a bug, please [report it on GitHub](https://github.com/ibericode/boxzilla/issues).
6661

67-
If you're on [one of the available premium plans](https://boxzillaplugin.com/pricing#utm_source=wp-plugin-repo&utm_medium=boxzilla&utm_campaign=description), please use the support email for a guaranteed & faster response.
62+
If you're on [one of the available premium plans](https://boxzillaplugin.com/pricing#utm_source=wp-plugin-repo&utm_medium=boxzilla&utm_campaign=description), please use the support email for a faster reply.
6863

6964
== Frequently Asked Questions ==
7065

@@ -74,24 +69,11 @@ Have a look at the [Boxzilla demo site](https://demo.boxzillaplugin.com/#utm_sou
7469

7570
= How to display a form in the box? =
7671

77-
The plugin is battle-tested with the plugins below but will work with any plugin that uses shortcodes.
78-
79-
- [MailChimp for WordPress](https://wordpress.org/plugins/mailchimp-for-wp/)
80-
- [Contact Form 7](https://wordpress.org/plugins/contact-form-7/)
81-
82-
= How to display sharing options in the box? =
83-
84-
The plugin is tested with the plugins below but will work with any plugin that uses shortcodes.
85-
86-
- [Social Sharing By Danny](https://wordpress.org/plugins/dvk-social-sharing/)
87-
- [Shareaholic](https://wordpress.org/plugins/shareaholic/)
88-
- [Social Media Feather](https://wordpress.org/plugins/social-media-feather/)
89-
- [WP Socializer](https://wordpress.org/plugins/wp-socializer/)
90-
- [Tweet, Like, Google +1 and Share](https://wordpress.org/plugins/only-tweet-like-share-and-google-1/)
72+
Boxzilla will work with any plugin that offers shortcodes, like [MailChimp for WordPress](https://wordpress.org/plugins/mailchimp-for-wp/).
9173

92-
= Can I have a box to open after clicking a certain link or button? =
74+
= Can I have a box open after clicking a certain link or button? =
9375

94-
Sure, just link to the box element.
76+
Sure, by linking to the box element.
9577

9678
*Example (box ID is 94 in this example)*
9779
`
@@ -107,14 +89,13 @@ Sure, just include `boxzilla-` followed by the box ID in the URL.
10789
http://your-wordpress-site.com/some-page/#boxzilla-94
10890
`
10991

110-
= How to set more advanced styling rules =
92+
= Can I customize the appearance of a box =
11193

112-
If you want more advanced styling, you can use CSS to further style the boxes. Every box gets its own unique #id as well as various CSS classes.
94+
Boxzilla comes with a simple interface for customizing most colors & borders of the box, but you're in no way limited to apply your own CSS rules.
11395

11496
`
11597
.boxzilla-{id} { } /* 1 particular box */
11698
.boxzilla { } /* all boxes */
117-
.boxzilla-close{ } /* the close button of the box */
11899
`
119100

120101
= I want to disable auto-paragraphs in the box content =
@@ -130,12 +111,12 @@ remove_filter( 'boxzilla_box_content', 'do_shortcode' );
130111
remove_filter( 'boxzilla_box_content', 'shortcode_unautop' );
131112
`
132113

133-
= I want to disable closing of the box =
114+
= I want to make it impossible to close a box =
134115
`
135-
add_filter( 'boxzilla_box_options', function( $opts ) {
116+
add_filter( 'boxzilla_box_options', function( $opts, $box ) {
136117
$opts['closable'] = false;
137118
return $opts;
138-
});
119+
}, 10, 2 );
139120
`
140121

141122
== Installation ==

0 commit comments

Comments
 (0)