Improved formatting for README.md and readme.txt
This commit is contained in:
104
README.md
104
README.md
@ -1,18 +1,45 @@
|
||||
# WP Multisite WaaS
|
||||
|
||||
The Complete Network Solution for transforming your WordPress Multisite into a Website as a Service (WaaS) platform.
|
||||
<p align="center">
|
||||
<img src="https://raw.githubusercontent.com/wpallstars/wp-multisite-waas/main/assets/images/logo.png" alt="WP Multisite WaaS Logo" width="300">
|
||||
</p>
|
||||
|
||||
[](http://www.gnu.org/licenses/gpl-2.0.html)
|
||||
[](https://wordpress.org/)
|
||||
[](https://php.net/)
|
||||
<p align="center">
|
||||
<strong>The Complete Network Solution for transforming your WordPress Multisite into a Website as a Service (WaaS) platform.</strong>
|
||||
</p>
|
||||
|
||||
## Description
|
||||
<p align="center">
|
||||
<a href="http://www.gnu.org/licenses/gpl-2.0.html"><img src="https://img.shields.io/badge/License-GPL%20v2-blue.svg" alt="License: GPL v2"></a>
|
||||
<a href="https://wordpress.org/"><img src="https://img.shields.io/badge/WordPress-6.7.1%20Tested-green.svg" alt="WordPress: 6.7.1 Tested"></a>
|
||||
<a href="https://php.net/"><img src="https://img.shields.io/badge/PHP-7.4.30%2B-purple.svg" alt="PHP: 7.4.30+"></a>
|
||||
<a href="https://github.com/superdav42/wp-multisite-waas/releases"><img src="https://img.shields.io/github/v/release/superdav42/wp-multisite-waas" alt="Latest Release"></a>
|
||||
</p>
|
||||
|
||||
WP Multisite WaaS helps you transform your WordPress Multisite installation into a powerful Website as a Service (WaaS) platform. This plugin enables you to offer website creation, hosting, and management services to your customers through a streamlined interface.
|
||||
## 🌟 Overview
|
||||
|
||||
Now community maintained.
|
||||
**WP Multisite WaaS** helps you transform your WordPress Multisite installation into a powerful Website as a Service (WaaS) platform. This plugin enables you to offer website creation, hosting, and management services to your customers through a streamlined interface.
|
||||
|
||||
## Installation
|
||||
This plugin was formerly known as WP Ultimo and is now community maintained.
|
||||
|
||||
## ✨ Key Features
|
||||
|
||||
- **Site Creation** - Allow customers to create their own sites in your network
|
||||
- **Domain Mapping** - Support for custom domains with automated DNS verification
|
||||
- **Payment Processing** - Integrations with popular payment gateways like Stripe and PayPal
|
||||
- **Plan Management** - Create and manage subscription plans with different features and limitations
|
||||
- **Template Sites** - Easily clone and use template sites for new customer websites
|
||||
- **Customer Dashboard** - Provide a professional management interface for your customers
|
||||
- **White Labeling** - Brand the platform as your own
|
||||
- **Hosting Integrations** - Connect with popular hosting control panels like cPanel, RunCloud, and more
|
||||
|
||||
## 📋 Requirements
|
||||
|
||||
- WordPress Multisite 5.3 or higher
|
||||
- PHP 7.4.30 or higher
|
||||
- MySQL 5.6 or higher
|
||||
- HTTPS enabled (recommended for secure checkout)
|
||||
|
||||
## 🔧 Installation
|
||||
|
||||
There are two recommended ways to install WP Multisite WaaS:
|
||||
|
||||
@ -23,65 +50,60 @@ There are two recommended ways to install WP Multisite WaaS:
|
||||
3. Navigate to Plugins > Add New > Upload Plugin
|
||||
4. Choose the downloaded ZIP file and click "Install Now"
|
||||
5. Network Activate the plugin through the 'Plugins' menu in WordPress
|
||||
6. Follow the step by step Wizard to set the plugin up
|
||||
6. Follow the step-by-step Wizard to set the plugin up
|
||||
|
||||
### Method 2: Using Git and Composer (For developers)
|
||||
|
||||
This method requires command-line access to your server and familiarity with Git and Composer.
|
||||
|
||||
1. Clone the repository to your plugins directory:
|
||||
```
|
||||
```bash
|
||||
cd wp-content/plugins/
|
||||
git clone https://github.com/superdav42/wp-multisite-waas.git
|
||||
cd wp-multisite-waas
|
||||
```
|
||||
|
||||
2. Install the required dependencies using Composer:
|
||||
```
|
||||
```bash
|
||||
composer install
|
||||
```
|
||||
|
||||
3. Network Activate the plugin in your WordPress Network Admin dashboard
|
||||
4. Follow the setup wizard to complete the installation
|
||||
|
||||
## Common Installation Issues
|
||||
## 🔍 Common Installation Issues
|
||||
|
||||
**"Failed opening required [...]/vendor/autoload_packages.php"**
|
||||
<details>
|
||||
<summary><strong>"Failed opening required [...]/vendor/autoload_packages.php"</strong></summary>
|
||||
<p>This error occurs when the required vendor files are missing. This typically happens when:</p>
|
||||
<ul>
|
||||
<li>You've downloaded the repository directly from GitHub without using a release package</li>
|
||||
<li>The composer dependencies haven't been installed</li>
|
||||
</ul>
|
||||
<p><strong>Solution:</strong> Use the pre-packaged release from the <a href="https://github.com/superdav42/wp-multisite-waas/releases">Releases page</a> or run <code>composer install</code> in the plugin directory.</p>
|
||||
</details>
|
||||
|
||||
This error occurs when the required vendor files are missing. This typically happens when:
|
||||
- You've downloaded the repository directly from GitHub without using a release package
|
||||
- The composer dependencies haven't been installed
|
||||
<details>
|
||||
<summary><strong>"Cannot declare class ComposerAutoloaderInitWPUltimoDependencies, because the name is already in use"</strong></summary>
|
||||
<p>This error usually occurs when updating from an older version of WP Ultimo or when multiple versions of the plugin are installed.</p>
|
||||
<p><strong>Solution:</strong> Deactivate and remove any older versions of WP Ultimo or WP Multisite WaaS before activating the new version.</p>
|
||||
</details>
|
||||
|
||||
Solution: Use the pre-packaged release from the [Releases page](https://github.com/superdav42/wp-multisite-waas/releases) or run `composer install` in the plugin directory.
|
||||
<details>
|
||||
<summary><strong>"Class 'WP_Ultimo\Database\Sites\Site_Query' not found"</strong></summary>
|
||||
<p>This error can occur if the plugin's autoloader isn't properly loading all the necessary classes.</p>
|
||||
<p><strong>Solution:</strong> Use the pre-packaged release from the <a href="https://github.com/superdav42/wp-multisite-waas/releases">Releases page</a> which includes all required files.</p>
|
||||
</details>
|
||||
|
||||
**"Cannot declare class ComposerAutoloaderInitWPUltimoDependencies, because the name is already in use"**
|
||||
|
||||
This error usually occurs when updating from an older version of WP Ultimo or when multiple versions of the plugin are installed.
|
||||
|
||||
Solution: Deactivate and remove any older versions of WP Ultimo or WP Multisite WaaS before activating the new version.
|
||||
|
||||
**"Class 'WP_Ultimo\Database\Sites\Site_Query' not found"**
|
||||
|
||||
This error can occur if the plugin's autoloader isn't properly loading all the necessary classes.
|
||||
|
||||
Solution: Use the pre-packaged release from the [Releases page](https://github.com/superdav42/wp-multisite-waas/releases) which includes all required files.
|
||||
|
||||
## Requirements
|
||||
|
||||
- WordPress Multisite 5.3 or higher
|
||||
- PHP 7.4.30 or higher
|
||||
- MySQL 5.6 or higher
|
||||
- HTTPS enabled (recommended for secure checkout)
|
||||
|
||||
## Support
|
||||
## 🆘 Support
|
||||
|
||||
For support, please open an issue on the [GitHub repository](https://github.com/superdav42/wp-multisite-waas/issues).
|
||||
|
||||
## Upgrade Notice
|
||||
## ⚠️ Upgrade Notice
|
||||
|
||||
We recommend running this in a staging environment before updating your production environment.
|
||||
|
||||
## Recent Changes
|
||||
## 📝 Recent Changes
|
||||
|
||||
### Version [2.3.4] - Released on 2024-01-31
|
||||
- Fixed: Unable to checkout with any payment gateway
|
||||
@ -95,14 +117,14 @@ We recommend running this in a staging environment before updating your producti
|
||||
|
||||
For the complete changelog, please see [readme.txt](readme.txt).
|
||||
|
||||
## Contributors
|
||||
## 👥 Contributors
|
||||
|
||||
WP Multisite WaaS is an open-source project with contributions from:
|
||||
- [aanduque](https://github.com/aanduque)
|
||||
- [superdav42](https://github.com/superdav42)
|
||||
- [And the community](https://github.com/superdav42/wp-multisite-waas/graphs/contributors)
|
||||
|
||||
## License
|
||||
## 📄 License
|
||||
|
||||
WP Multisite WaaS is licensed under the GPL v2 or later.
|
||||
|
||||
|
Reference in New Issue
Block a user