You've already forked wp-fedistream
docs: Update README for v0.4.0
- Update version badge to 0.4.0 - Add CI/CD badge - Add release package installation instructions - Add license key section - Add releases section - Update from-source instructions for submodules Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
41
README.md
41
README.md
@@ -2,10 +2,11 @@
|
|||||||
|
|
||||||
Stream music over ActivityPub - Build your own music streaming platform for Musicians and Labels.
|
Stream music over ActivityPub - Build your own music streaming platform for Musicians and Labels.
|
||||||
|
|
||||||
[](CHANGELOG.md)
|
[](CHANGELOG.md)
|
||||||
[](https://php.net)
|
[](https://php.net)
|
||||||
[](https://wordpress.org)
|
[](https://wordpress.org)
|
||||||
[](https://www.gnu.org/licenses/gpl-2.0.html)
|
[](https://www.gnu.org/licenses/gpl-2.0.html)
|
||||||
|
[](https://src.bundespruefstelle.ch/magdev/wp-fedistream/actions)
|
||||||
|
|
||||||
## Description
|
## Description
|
||||||
|
|
||||||
@@ -31,29 +32,47 @@ WP FediStream is a WordPress plugin that enables musicians, bands, and labels to
|
|||||||
|
|
||||||
- PHP 8.3 or higher
|
- PHP 8.3 or higher
|
||||||
- WordPress 6.4 or higher
|
- WordPress 6.4 or higher
|
||||||
- Composer (for development/installation)
|
- Valid license key (required for frontend features)
|
||||||
|
|
||||||
### Optional
|
### Optional
|
||||||
|
|
||||||
- [ActivityPub Plugin](https://wordpress.org/plugins/activitypub/) - For Fediverse integration
|
- [ActivityPub Plugin](https://wordpress.org/plugins/activitypub/) - For Fediverse integration
|
||||||
- [WooCommerce](https://woocommerce.com/) 10.0+ - For selling music
|
- [WooCommerce](https://woocommerce.com/) 10.0+ - For selling music
|
||||||
|
|
||||||
|
## License Key
|
||||||
|
|
||||||
|
WP FediStream requires a valid license key for frontend functionality (player, shortcodes, ActivityPub). The admin dashboard works without a license, allowing you to configure the plugin before activation.
|
||||||
|
|
||||||
|
To obtain a license key, contact the author or purchase from the official website.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### From Source
|
### From Release Package (Recommended)
|
||||||
|
|
||||||
1. Clone or download the repository to your WordPress plugins directory:
|
1. Download the latest release from the [Releases page](https://src.bundespruefstelle.ch/magdev/wp-fedistream/releases)
|
||||||
|
|
||||||
|
2. Upload the ZIP file via **Plugins > Add New > Upload Plugin** in WordPress admin
|
||||||
|
|
||||||
|
3. Activate the plugin under **Plugins > Installed Plugins**
|
||||||
|
|
||||||
|
4. Navigate to **FediStream > Settings** and enter your license key
|
||||||
|
|
||||||
|
5. Start using the plugin via the **FediStream** admin menu
|
||||||
|
|
||||||
|
### From Source (Development)
|
||||||
|
|
||||||
|
1. Clone the repository to your WordPress plugins directory:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd wp-content/plugins/
|
cd wp-content/plugins/
|
||||||
git clone https://src.bundespruefstelle.ch/magdev/wp-fedistream.git
|
git clone --recurse-submodules https://src.bundespruefstelle.ch/magdev/wp-fedistream.git
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Install Composer dependencies:
|
2. Install Composer dependencies:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd wp-fedistream
|
cd wp-fedistream
|
||||||
composer install --no-dev
|
composer install
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Activate the plugin in WordPress admin under **Plugins > Installed Plugins**
|
3. Activate the plugin in WordPress admin under **Plugins > Installed Plugins**
|
||||||
@@ -133,6 +152,16 @@ wp-fedistream/
|
|||||||
└── wp-fedistream.php # Plugin entry point
|
└── wp-fedistream.php # Plugin entry point
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Releases
|
||||||
|
|
||||||
|
Release packages are automatically built via Gitea Actions when a version tag is pushed. Each release includes:
|
||||||
|
|
||||||
|
- Production-ready ZIP package with all dependencies
|
||||||
|
- SHA256 checksum for verification
|
||||||
|
- Changelog notes extracted from CHANGELOG.md
|
||||||
|
|
||||||
|
Download releases from: <https://src.bundespruefstelle.ch/magdev/wp-fedistream/releases>
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
This project is in early development. Contributions, bug reports, and feature requests are welcome.
|
This project is in early development. Contributions, bug reports, and feature requests are welcome.
|
||||||
|
|||||||
Reference in New Issue
Block a user