Skip to content

Commit 1a60424

Browse files
authored
Add information to the readme file
1 parent 8f0282c commit 1a60424

File tree

1 file changed

+76
-1
lines changed

1 file changed

+76
-1
lines changed

README.md

Lines changed: 76 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,77 @@
11
# accessibility-font-resizer
2-
Resize your website font sizes for better accessibility
2+
Make accessibility better for your visitors by enabling them to resize the text on your website and make it bigger.
3+
4+
## Description
5+
6+
Would you like to enable all your visitors to enjoy your site? Not all visitors sees your website the way you do.
7+
8+
This plugin allows you to make your website easier to read by to give the visitors of your site the option to change the font size of your text.
9+
10+
Benefits:
11+
12+
* Enables more visitor to enjoy your website with custom large and very large font sizes.
13+
* Works no matter if your site uses percentage, pixels, em or rem as your font sizes.
14+
* Your visitor's text size is remembered when (s)he revisits the site.
15+
* No coding skills required.
16+
* Works within minutes.
17+
* Flexible and easy to use.
18+
* Won't slow your website.
19+
20+
This plugin was created and is maintained by SatelliteWP, a [WordPress maintenance service](https://www.satellitewp.com/en?utm_source=accessibility-font-resizer).
21+
22+
23+
## Compatibility
24+
25+
This plugin is multilingual ready.
26+
27+
28+
## Installation
29+
30+
1. In your WordPress administration section, goto `Plugins > Add new`.
31+
1. Search for `Accessibility font resizer`.
32+
1. Click on 'Install now'.
33+
1. Once the plugin is installed, click on 'Activate'.
34+
1. Go to `Settings > Font resizer` to edit the plugin's settings.
35+
36+
37+
## Frequently Asked Questions
38+
39+
### How can I activate the function of the plugin?
40+
41+
Once the plugin is activated, the functions of the plugin work.
42+
43+
44+
### I have activated the plugin, now what?
45+
46+
To be able to use the plugin, you should create a menu. You can use (or not) that menu in a widget.
47+
48+
The trick is to simply add the CSS class `afr-normal` to display normal size, `afr-large` for large text and `aft-xlarge` for very large text.
49+
50+
You can also apply this CSS technique in your PHP files or directly in your content.
51+
52+
53+
### I click the resizer, but (some of) my fonts don't change in size. How to fix that?
54+
55+
Simply inspect the element that is not resizing properly to know what element it is. Then, simply add it to the 'HTML Elements' section in the options' screen.
56+
57+
You can find the plugin's settings in `Settings > Font resizer`.
58+
59+
60+
### I use font-size in rem in my theme, will it work?
61+
62+
It's not a problem. The plugin works with all units!
63+
64+
65+
### I use font-size in pixels in my theme, will it work?
66+
67+
It's not a problem. The plugin works with all units!
68+
69+
70+
### I use font-size in percentage in my theme, will it work?
71+
72+
It's not a problem. The plugin works with all units!
73+
74+
75+
### I want to use a shortcode in my content element. How?
76+
77+
There is no shortcode for this plugin. You can call CSS classes directly without the need of a shortcode.

0 commit comments

Comments
 (0)