Skip to content

Commit acafbd7

Browse files
Update README.md (#125)
This PR updates the readme file. 1. Removed many accidental line breaks 2. Updated migration instructions (copied from CP docs) 3. Misc minor changes in text 4. Updated screenshots 5. Added 1.6.0 changelog
1 parent 8508dc5 commit acafbd7

File tree

1 file changed

+65
-102
lines changed

1 file changed

+65
-102
lines changed

README.md

Lines changed: 65 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -2,132 +2,95 @@
22

33
![](assets/banner-772x250.png)
44

5-
This is a plugin for WordPress that switches your installation to
6-
[ClassicPress](https://www.classicpress.net).
5+
This is a plugin for WordPress that switches your installation to [ClassicPress](https://www.classicpress.net).
76

8-
Version 1.5 of this plugin also added a switcher tool for ClassicPress
9-
that can be used to install other versions, test nightly builds and even revert your
10-
site to WordPress.
7+
Version 1.5 of this plugin also added a switcher tool for ClassicPress that can be used to install other versions, test nightly builds and even revert your site to WordPress.
118

129
## The CMS for Creators
1310

14-
ClassicPress takes your website to the next level with the same features and
15-
functionality that you enjoyed with WordPress, but with more attention to the
16-
most common needs of a business website.
11+
ClassicPress takes your website to the next level with the same features and functionality that you enjoyed with WordPress, but with more attention to the most common needs of a business website.
1712

18-
**PLEASE NOTE:** ClassicPress is stable software, but it is important to take a
19-
backup before switching a live production site to ClassicPress. Please also
20-
ensure any known conflicting plugins are **deactivated** (see list
21-
[here](https://docs.classicpress.net/installing-classicpress/#plugin-conflicts)).
13+
**PLEASE NOTE:** ClassicPress is stable software, but it is important to take a backup before switching a live production site to ClassicPress.
2214

2315
## What version of WordPress does the plugin work with?
2416

2517
You can always see the latest supported version by going to [Get ClassicPress](https://www.classicpress.net/get-classicpress/#switch-to-classicpress).
2618

2719
## Installation
2820

29-
To **install a fresh version of ClassicPress on a new site**, you do not need
30-
this plugin. See our
31-
[installation instructions](https://docs.classicpress.net/installing-classicpress/)
32-
instead.
33-
34-
To **install ClassicPress on a current WordPress site** (switch a current
35-
WordPress site to ClassicPress):
36-
37-
1. Back up the current site files and database. You can do a manual backup in
38-
your hosting panel and export the database, or you can use a backup plugin.
39-
2. Download this plugin from the
40-
[Releases page](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/releases)
41-
here on GitHub.
42-
3. Install the downloaded zip file from within the WordPress dashboard
43-
("Plugins" -> "Add New" -> "Upload Plugin").
21+
To **install a fresh version of ClassicPress on a new site**, you do not need this plugin.
22+
See our [installation instructions](https://docs.classicpress.net/installing-classicpress/) instead.
23+
24+
To **install ClassicPress on a current WordPress site** (switch a current WordPress site to ClassicPress):
25+
26+
1. Back up the current site files and database. You can do a manual backup in your hosting panel and export the database, or you can use a backup plugin.
27+
2. Download the latest version of the ClassicPress migration plugin from the [ClassicPress Plugin Directory](https://directory.classicpress.net/plugins/switch-to-classicpress/).
28+
3. Install the downloaded zip file from within the WordPress dashboard ("Plugins" -> "Add New" -> "Upload Plugin").
4429
4. Activate this plugin ("Switch to ClassicPress") after it is installed.
45-
5. Go to the ClassicPress Migration plugin by clicking the **Switch** link in
46-
this plugin's table row, or at **Tools -> Switch to ClassicPress**.
47-
6. If all the checks pass, press the **Switch this site to ClassicPress now!**
48-
button. If not, you'll probably need to upgrade WordPress or PHP.
49-
7. The migration process may take a few minutes depending on your hosting
50-
provider, so go grab some water or a beverage of your choice 🙂
51-
8. When the process is finished, you should see the ClassicPress About screen.
52-
At this point it is safe to delete the “Switch to ClassicPress” plugin.
53-
9. You may be prompted to upgrade ClassicPress immediately after switching from
54-
WordPress. This is normal, and it is safe to upgrade.
55-
56-
If something is wrong, please let us know in
57-
[our support forum](https://forums.classicpress.net/c/support/migration-plugin).
30+
5. Go to the settings of the ClassicPress migration plugin at "Tools" -> "Switch to ClassicPress".
31+
6. To proceed with the switch it is necessary that all pre-flight checks succeed, with a green or yellow check mark. A yellow check mark requires your attention, so read this information carefully.
32+
7. Press the **Switch this site to ClassicPress now!** button.
33+
8. The migration process may take a few minutes depending on your hosting provider, so go grab some water or a beverage of your choice 🙂
34+
9. When the process is finished, you should see the ClassicPress About screen.
35+
10. To complete the migration process you must visit the Updates page and press the **Re-Install Now** button.
36+
11. You may be prompted to upgrade ClassicPress immediately after switching from WordPress. This is normal, and it is safe to upgrade.
37+
38+
At this point it is safe to delete the “Switch to ClassicPress” plugin.
39+
40+
If something is wrong, please let us know in [our support forum](https://forums.classicpress.net/c/support/migration-plugin).
5841

5942
## Frequently Asked Questions
6043

6144
### Will my current plugins and themes work in ClassicPress?
6245

63-
Plugins that require Blocks might not work well in ClassicPress, you should test
64-
any plugins you plan to use and verify they work correctly.
65-
If you see something unusual it may be a bug with
66-
ClassicPress, and you can get help on
67-
[our support forum](https://forums.classicpress.net/c/support/)
68-
or
69-
[GitHub](https://github.com/ClassicPress).
46+
Plugins that require Blocks might not work well in ClassicPress, you should test any plugins you plan to use and verify they work correctly.
47+
If you see something unusual it may be a bug with ClassicPress, and you can get help on [our support forum](https://forums.classicpress.net/c/support/) or [GitHub](https://github.com/ClassicPress).
7048

7149
### How can I use this plugin with an unsupported version of WordPress?
7250

73-
This plugin currently supports migrating from WordPress versions starting at
74-
`4.9.0`.
51+
This plugin currently supports migrating from WordPress versions starting at `4.9.0`.
7552

76-
We update the plugin as quickly as possible when a new version of WordPress
77-
comes out, but we do need to test each new version for compatibility with the
78-
plugin first.
79-
80-
If you would like to migrate from a different version of WordPress **at your
81-
own risk**, you can use the following code in your current theme's
82-
`functions.php` file or a mu-plugin to enable the migration:
53+
We update the plugin as quickly as possible when a new version of WordPress comes out, but we do need to test each new version for compatibility with the plugin first.
8354

55+
If you would like to migrate from a different version of WordPress **at your own risk**, you can use the following code in your current theme's `functions.php` file or a mu-plugin to enable the migration:
8456
`add_filter( 'classicpress_ignore_wp_version', '__return_true' );`
8557

86-
With each new WordPress release, it's very helpful for us to have multiple
87-
reports of whether the migration plugin works with the new version. You can
88-
use the filter above to test the migration process, and you can tell us about
89-
the results of your testing
90-
[on GitHub](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/issues)
91-
or
92-
[on the support subforum for the migration plugin](https://forums.classicpress.net/c/support/migration-plugin).
58+
With each new WordPress release, it's very helpful for us to have multiple reports of whether the migration plugin works with the new version.
59+
You can use the filter above to test the migration process, and you can tell us about the results of your testing [on GitHub](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/issues) or [on the support subforum for the migration plugin](https://forums.classicpress.net/c/support/migration-plugin).
9360

9461
### I need help with something else, what should I do?
9562

9663
Like all of ClassicPress, our support is a volunteer effort by the community.
97-
If you need help with something, please let us know in
98-
[our support forum](https://forums.classicpress.net/c/support/)
99-
or
100-
[Zulip chat](https://classicpress.zulipchat.com/register/).
64+
If you need help with something, please let us know in [our support forum](https://forums.classicpress.net/c/support/) or [Zulip chat](https://classicpress.zulipchat.com/register/).
10165

10266
## Screenshots
10367

104-
The plugin's admin page with information and the controls to start the migration:
105-
![](assets/screenshot-1.png)
68+
The plugin's admin page with information and the controls to start the migration:
69+
70+
![Screenshot-1](https://github.com/user-attachments/assets/d27844d7-7629-4e17-91d2-f68761c137a0)
10671

10772
<br>
10873

109-
The plugin's admin page with an error that is blocking the migration:
110-
![](assets/screenshot-2.png)
74+
The plugin's migration progress page:
75+
76+
![Screenshot-2](https://github.com/user-attachments/assets/429b2248-1e0d-4ce0-97e7-5ed95af6b00a)
11177

11278
<br>
11379

114-
The plugin's migration progress page:
115-
![](assets/screenshot-3.png)
116-
117-
The About ClassicPress screen that appears at the end of the migration: <br>
118-
![](assets/screenshot-4.png)
80+
The About ClassicPress screen that appears at the end of the migration:
81+
82+
![Screenshot-3](https://github.com/user-attachments/assets/f55504a1-a8eb-4bad-9214-9d2e7d24a523)
11983

12084
## Changelog
12185

12286
### 0.1.0
12387

124-
The initial public release of this plugin. Switches to an early ClassicPress
125-
alpha release.
88+
- The initial public release of this plugin. Switches to an early ClassicPress alpha release.
12689

12790
### 0.2.0
12891

129-
Switches to ClassicPress `1.0.0-beta1` with working auto-updates. Also
130-
supports migrating multisite WordPress installations to ClassicPress.
92+
- Switches to ClassicPress `1.0.0-beta1` with working auto-updates.
93+
- Also supports migrating multisite WordPress installations to ClassicPress.
13194

13295
### 0.3.0
13396

@@ -158,42 +121,31 @@ supports migrating multisite WordPress installations to ClassicPress.
158121

159122
- Support migrating from WP up to 5.1.0.
160123
- Switch to ClassicPress `1.0.0` by default.
161-
- Add an advanced feature that allows switching to any version of WordPress or
162-
ClassicPress.
124+
- Add an advanced feature that allows switching to any version of WordPress or ClassicPress.
163125

164126
### 1.0.1
165127

166-
- Load the supported WordPress version and the target ClassicPress version from
167-
a remote API endpoint, so that a new release of the migration plugin is not
168-
required with every new WordPress or ClassicPress release.
128+
- Load the supported WordPress version and the target ClassicPress version from a remote API endpoint, so that a new release of the migration plugin is not required with every new WordPress or ClassicPress release.
169129

170130
### 1.1.0
171131

172-
- Change pre-existing `composer.json` from an error to a warning
173-
([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/issues/61))
174-
- Minor fix for disorganized/jumbled output in some cases
175-
([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/issues/59#issuecomment-495459514))
132+
- Change pre-existing `composer.json` from an error to a warning ([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/issues/61))
133+
- Minor fix for disorganized/jumbled output in some cases ([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/issues/59#issuecomment-495459514))
176134

177135
### 1.2.0
178136

179-
- Add translation files and translate the plugin into Russian
180-
([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/pull/60))
181-
- Fix an issue with incorrect upgrade notices appearing immediately after a
182-
custom migration
183-
([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/issues/62))
184-
- Fix an issue with stale WordPress news items appearing in the dashboard after
185-
migrating to ClassicPress
186-
([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/issues/67))
187-
137+
- Add translation files and translate the plugin into Russian ([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/pull/60))
138+
- Fix an issue with incorrect upgrade notices appearing immediately after a custom migration ([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/issues/62))
139+
- Fix an issue with stale WordPress news items appearing in the dashboard after migrating to ClassicPress ([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/issues/67))
140+
188141
### 1.3.0
189142

190-
- Add Plugin and Theme check sections
191-
([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/pull/74))
192-
143+
- Add Plugin and Theme check sections ([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/pull/74))
144+
193145
### 1.3.1
194146

195147
- Remove stray files from release
196-
148+
197149
### 1.4.0
198150

199151
- Direct blocking issues to ClassicPress Forum (#82)
@@ -232,3 +184,14 @@ supports migrating multisite WordPress installations to ClassicPress.
232184
- Change Core File check to show any modified files on the page rather than in the console
233185
- Display override function info for unsupported WP versions when applicable
234186
- Correct links and update wording as needed
187+
188+
### 1.6.0
189+
190+
- Fix "modified files" warning when locale is not en_US
191+
- Update to Plugin and Theme Warnings
192+
- Add override for WP version check in "General setting"
193+
- Fixed Functions in admin-page.php
194+
- Adding more support for translation
195+
- Translation related fixes
196+
- Validate custom migration URL
197+
- Regenerate POT file

0 commit comments

Comments
 (0)