Skip to content

Commit 2d8eee2

Browse files
committed
Docs: Update readme files
1 parent 81d3cbf commit 2d8eee2

File tree

2 files changed

+50
-43
lines changed

2 files changed

+50
-43
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# Genesis js / no-js
1+
# Genesis JS / No JS
22

3-
Make front-end styling easier for child themes on the Genesis Framework based on whether JavaScript is enabled or not.
3+
Make front end styling easier for child themes on the Genesis Framework based on whether JavaScript is enabled or not.
44

55
## Description
66

7-
If you look at the source of a WordPress back-end page, you'll see it has a body class of `no-js`. Immediately after the opening `body` tag is a small script which replaces `no-js` with `js` (you can see the amended class with Firebug / Inspector).
7+
If you look at the source of a WordPress back end page, you'll see it has a body class of `no-js`. Immediately after the opening `body` tag is a small script which replaces `no-js` with `js` (you can see the amended class with Firebug / Inspector).
88

99
WordPress uses this to apply different styles to the same elements, depending on whether JavaScript is present or not.
1010

11-
This plugin recreates the same effect, but for the front-end of <a href="http://genesis-theme-framework.com/">Genesis Framework</a> child themes. It uses the `genesis_before` hook supplied by Genesis, so it won't work for other themes.
11+
This plugin recreates the same effect, but for the front end of <a href="http://genesis-theme-framework.com/">Genesis Framework</a> child themes. It uses the `genesis_before` hook supplied by Genesis, so it won't work for other themes.
1212

1313
The script is fairly small so does not block rendering of other content for any noticeable length of time.
1414

@@ -42,11 +42,17 @@ Using git, browse to your `/wp-content/plugins/` directory and clone this reposi
4242

4343
Then go to your Plugins screen and click __Activate__.
4444

45+
### Composer
46+
47+
~~~sh
48+
composer require gamajo/genesis-js-no-js
49+
~~~
50+
4551
## Updates
4652

4753
This plugin supports the [GitHub Updater](https://github.com/afragen/github-updater) plugin, so if you install that, this plugin becomes automatically updateable direct from GitHub.
4854

4955
## Credits
5056

5157
Built by [Gary Jones](https://twitter.com/GaryJ)
52-
Copyright 2011 [Gamajo Tech](http://gamajo.com/)
58+
Copyright 2011 [Gamajo](https://gamajo.com/)

readme.txt

Lines changed: 39 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,63 @@
1-
=== Plugin Name ===
1+
=== Genesis JS / No JS ===
22
Contributors: GaryJ
33
Donate link: http://code.garyjones.co.uk/donate/
44
Tags: genesis, js-no-js
5-
Requires at least: 3.0
5+
Requires at least: 4.6
66
Tested up to: 4.8.1
77
Stable tag: 2.1.0
88

9-
Make front-end styling easier for child themes on the Genesis Framework based on whether JavaScript is enabled or not.
9+
Make front end styling easier for child themes on the Genesis Framework based on whether JavaScript is enabled or not.
1010

1111
== Description ==
1212

13-
Make front-end styling easier for child themes on the <a href="http://genesis-theme-framework.com/">Genesis Framework</a> based on whether JavaScript is enabled or not.
13+
Make front end styling easier for child themes on the <a href="http://genesis-theme-framework.com/">Genesis Framework</a> based on whether JavaScript is enabled or not.
1414

15-
Adds a `no-js` body class to the front-end, and a script on `genesis_before` which immediately changes the class to `js` if JavaScript is enabled.
16-
This is how WP does things on the back-end, to allow different styles for the same elements depending if JavaScript is active or not.
15+
Adds a `no-js` body class to the front end, and a script on `genesis_before` which immediately changes the class to `js` if JavaScript is enabled.
16+
This is how WP does things on the back end, to allow different styles for the same elements depending if JavaScript is active or not.
1717

1818
This plugin is only useful if you're using a child theme of the Genesis Framework since it uses the `genesis_before` hook.
1919

2020
== Installation ==
2121

22-
1. Unzip and upload `genesis-js-no-js` folder to the `/wp-content/plugins/` directory
23-
1. Activate the plugin through the 'Plugins' menu in WordPress
22+
Once this plugin is installed and activated, then it will work automatically. There are no options, and nothing to set-up.
2423

25-
Once installed and activated, then the plugin will work. There are no options, and nothing to set-up.
24+
= Upload =
25+
26+
1. Download the latest tagged archive (choose the "zip" option).
27+
2. Go to the __Plugins -> Add New__ screen and click the __Upload__ tab.
28+
3. Upload the zipped archive directly.
29+
4. Go to the Plugins screen and click __Activate__.
30+
31+
= Manual =
32+
33+
1. Download the latest tagged archive (choose the "zip" option).
34+
2. Unzip the archive.
35+
3. Copy the folder to your `/wp-content/plugins/` directory.
36+
4. Go to the Plugins screen and click __Activate__.
37+
38+
Check out the Codex for more information about [installing plugins manually](http://codex.wordpress.org/Managing_Plugins#Manual_Plugin_Installation).
39+
40+
= Git =
41+
42+
Using git, browse to your `/wp-content/plugins/` directory and clone this repository:
43+
44+
`git clone git@github.com:GaryJones/genesis-js-no-js.git`
45+
46+
Then go to your Plugins screen and click __Activate__.
47+
48+
= Composer =
49+
50+
`composer require gamajo/genesis-js-no-js`
2651

2752
== Frequently Asked Questions ==
2853

2954
= What does this plugin actually do? =
3055

31-
If you look at the source of a WordPress back-end page, you'll see it has a body class of `no-js`. Immediately after the opening `body` tag is a small script which replaces `no-js` with `js` (you can see the amended class with Firebug / Inspector).
56+
If you look at the source of a WordPress back end page, you'll see it has a body class of `no-js`. Immediately after the opening `body` tag is a small script which replaces `no-js` with `js` (you can see the amended class with browser developer tools).
3257

3358
WordPress uses this to apply different styles to the same elements, depending on whether JavaScript is present or not.
3459

35-
This plugin recreates the same effect, but for the front-end of <a href="http://genesis-theme-framework.com/">Genesis Framework</a> child themes.
60+
This plugin recreates the same effect, but for the front end of <a href="http://genesis-theme-framework.com/">Genesis Framework</a> child themes.
3661

3762
= Shouldn't the script be at the end of the page? =
3863

@@ -42,33 +67,9 @@ Doing it immediately also reduces a flash of incorrectly styled content, as the
4267

4368
== Changelog ==
4469

45-
= 2.1.0 =
46-
* Load plugin text domain.
47-
* Add `composer.json`.
48-
* Better change log format.
49-
* Tweak documentation.
50-
51-
= 2.0.0 =
52-
* GitHub Updater plugin support
53-
* Refactor class into a new file. Stops using half-implemented Singleton pattern.
54-
* Update documentation.
55-
56-
= 1.0.1 =
57-
* Improved plugin so script is hooked in with priority 1 - avoids a theme placing anything before the script (props [Josh Stauffer](http://twitter.com/joshstauffer))
58-
59-
= 1.0 =
60-
* First public version.
70+
See <a href="https://github.com/GaryJones/genesis-js-no-js/blob/master/CHANGELOG.md">CHANGELOG.md</a> for all of the changes.
6171

6272
== Upgrade Notice ==
6373

64-
= 2.1.0 =
65-
Load plugin text domain.
66-
67-
= 2.0.0 =
68-
Update to add GitHub Updater plugin support.
69-
70-
= 1.0.1 =
71-
Minor change to avoid potential problems with themes hooking in elements before the script.
72-
73-
= 1.0 =
74-
Update from nothingness. You will feel better for it.
74+
= 3.0.0 =
75+
Requires PHP 7.1 and WordPress 4.6.

0 commit comments

Comments
 (0)