Documentation
UZWay addon documentation
Product documentation for addon creators and users: installation, packaging requirements, updates, capabilities, reviews, and publishing expectations.
Addon lifecycle
Every addon moves through the same lifecycle: build, declare, package, publish, install, review, and update.
- Build the browser-facing UI and behavior.
- Declare metadata and permissions in the manifest.
- Package the addon as `.uzwaddon`.
- Publish the package and metadata.
- Users install it from the addon detail page.
- Users can leave reviews and ratings after using it.
- Developers publish updates by increasing the version.
Addon listing reference
| Listing field |
Example |
Description |
| Name |
World Clock |
Public name shown in the marketplace. |
| Summary |
Time in major cities with a clean mobile layout. |
Short value statement. |
| Category |
Productivity |
Where the addon appears in browsing pages. |
| Version |
1.0.0 |
Current published release. |
| Capabilities |
Local storage |
Features the addon needs from the browser. |
| Compatibility |
UZWay Browser 1.0.0+ |
Minimum browser version. |
| Support notes |
How to report problems |
Help path for users. |
Supported capability names
- Local storage - stores user preferences or local addon data in the browser.
- File input - lets the user select local files for processing.
- Clipboard - reads from or writes to the clipboard only after user action.
- Network access - connects to an external service and must be clearly explained.
Versioning
Use semantic versioning. Increment patch for fixes, minor for new backwards-compatible features, and major for breaking changes or data format changes.
Installation and updates
- User clicks Add to UZWay Browser.
- The `.uzwaddon` package downloads.
- UZWay Browser validates the package information.
- The browser installs the addon and opens `launch_url`.
- When a newer version is published, users can install the updated package.
User reviews
- Users can rate addons from 1 to 5.
- Reviews should describe real usage, bugs, compatibility, or feature requests.
- Developers should use reviews to prioritize fixes and updates.
- Abusive, unrelated, or spam reviews may be moderated.