Lesson 8 – Packaging and distributing your add-on

Packaging and distributing your MainWP add-on involves several steps to ensure it’s properly formatted, documented, and easily installable by users. Here’s a guide to help you through the process:

Prepare Your Add-on

Make sure your add-on is fully functional and thoroughly tested.
Ensure your extension adheres to MainWP’s coding standards and guidelines.
Include necessary documentation, such as installation instructions, usage guides, and any prerequisites.

Package Your Add-on

Create a ZIP file containing all the files and folders necessary for your extension.
Ensure the ZIP file is well-organized and follows a logical structure.
Exclude any development-specific files or directories that aren’t needed for the end user.

Versioning

Assign a version number to your add-on following the Semantic Versioning (SemVer) standard (e.g., MAJOR.MINOR.PATCH).
Update the version number in your add-on’s code and documentation accordingly.

Documentation

Provide comprehensive documentation for your add-on.
Document installation steps, configuration options, usage instructions, and troubleshooting tips.
Include any licensing information or terms of use.

Licensing

Decide on the licensing model for your add-on (e.g., open-source, freemium, premium).
Clearly state the licensing terms and any restrictions on usage, redistribution, or modification.

Distribution Platforms

Choose one or more platforms for distributing your MainWP add-on. This could include:
- WordPress.org plugin repository
- Your own website
- Third-party marketplaces
If distributing through WordPress.org, follow their submission guidelines and upload your add-on to the repository.

We are here to assist with promotion on whichever platform you choose. Additionally, MainWP can list your add-on in the MainWP Marketplace so that our users can easily find it and get started.

MainWP Marketplace Listing Details

If you decide to distribute your add-on through the official MainWP Marketplace, please provide the following:

Add-on URL
Title
Description
Short description
3-5 Screenshots (1920px x 1080px)
Icon (min 512px x 512px)
Up to 10 tags (optional)
Add-on author company name
Add-on author company URL
Add-on author company Privacy Policy URL
Documentation URL
Changelog URL
YouTube Video URL (optional)
Additional Notes (optional)

Promotion

We will work with you to create a mutually beneficial launch plan which might include the following:

Adding each other on respective websites (which can include an exclusive landing page, product page, or blog post)
Emails to our respective customers announcing our partnership
Social posts
PR Releases
Mention in respective newsletters

Support and Updates

Establish a support system for users to reach out with questions, bug reports, or feature requests.
Commit to providing regular updates and bug fixes to maintain compatibility with MainWP and WordPress core updates.

Feedback and Iteration

Listen to user feedback and iterate on your add-on based on suggestions and bug reports.
Continuously improve your add-on to meet the evolving needs of MainWP users.

By following these steps, you can effectively package and distribute your MainWP add-on to make it accessible to a wider audience while ensuring a smooth user experience.

In the next Lesson we will be going over Managing updates and version control.

Previous Lesson

Next Lesson