Skip to content

Commit

Permalink
docs: update the readme.txt and the plugin.php to improve the launch …
Browse files Browse the repository at this point in the history
…in WordPress (#47)
  • Loading branch information
MaferMazu authored Oct 12, 2023
1 parent 9094830 commit e32f419
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 26 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,9 @@ Connect your WordPress site with your Open edX platform by following these steps

# Open edX Compatibility

- Palm or latest
- Tested from Olive

**NOTE:** Enrollment of users who are not platform users is only supported for versions after Palm.
**NOTE:** Enrollment of users who are not platform users (Create course enrollment allowed) is only supported for versions equal to or after Quince.

# Getting Help

Expand Down
41 changes: 29 additions & 12 deletions README.txt
Original file line number Diff line number Diff line change
@@ -1,21 +1,41 @@
=== Open edX WooCommerce Plugin ===
Contributors: (this should be a list of wordpress.org userid's)
Donate link: https://edunext.co/
Tags: openedx, woocommerce, integration, open source, courses
Requires at least: 6.3.1
Contributors: felipemontoya, julianrg2, mafermazu
Tags: openedx, open edx, woocommerce, lms, courses
Requires at least: 6.3
Tested up to: 6.3.1
Requires PHP: 8.0.29
Requires PHP: 8.0
Stable tag: 1.14.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

It is a free, open-source WordPress plugin that aims to integrate third-party e-commerce, WooCommerce, with your Open edX platform.
You can sell your Open edX courses with WooCommerce using this free and open-source WordPress plugin.

== Description ==

It is a free, open-source WordPress plugin that aims to integrate third-party e-commerce, WooCommerce, with your Open edX platform.
The "Open edX WooCommerce Plugin" is a free and open-source WordPress plugin that allows you to integrate WooCommerce with your Open edX platform.

Below are some links to help you get started with Open edX WooCommerce Plugin
**What does this mean?**
You can create Open edX courses as products in WooCommerce, and when you perform purchase or refund operations for these products, your Open edX platform will reflect these changes.

Here are some things you can do with this plugin:

- **Create Open edX courses as products:** When you create products using WooCommerce, you can designate them as Open edX courses. If you do, you can assign the course mode and course_id you registered in your Open edX platform.

- **Add settings for the connection with Open edX:** You'll have a new option in your WordPress settings to store authentication-related information for your Open edX platform.

- **Enrollment Manager:** You'll have a table that records all enrollment requests made through purchasing products that are Open edX courses.

- **View the enrollment requests from the orders:** When a person purchases WordPress, a WooCommerce order is generated. If an order includes a product that is an Open edX course, you can easily access the related enrollment request created with this plugin.

- **Create enrollments in Open edX:** When an order containing an Open edX course is processed, it automatically creates an enrollment request.
- You can also include the option to apply the "force" flag, disregarding the course's enrollment end dates.
- Starting from version Quince of Open edX, you can use the option to create enrollment allowed for non-registered users on the platform.

- **Create soft unenrollments from refunds:** The enrollment record is maintained, but the "is_active" attribute of the enrollment is false. Deleting an "enrollment allowed" is also supported, but only from version Quince.
Obtain enrollment information: This requests the Open edX APIs to retrieve the enrollment status of a user in a course.


Below are some links to help you get started with Open edX WooCommerce Plugin:

- <a href="https://edunext-docs-openedx-woocommerce-plugin.readthedocs-hosted.com/en/latest/quickstart.html" target="_blank">Quick Start Guide</a>
- <a href="https://edunext-docs-openedx-woocommerce-plugin.readthedocs-hosted.com/en/latest/how-tos/index.html" target="_blank">How-to Guides</a>
Expand All @@ -25,7 +45,7 @@ Below are some links to help you get started with Open edX WooCommerce Plugin
= Minimum Requirements =

* PHP 8.0 or greater is recommended
* Wordpress 6.3.1
* Wordpress 6.3
* [WooCommerce plugin](https://wordpress.org/plugins/woocommerce)

= Manual installation =
Expand Down Expand Up @@ -53,9 +73,6 @@ Contributions are very welcome. Please read [How To Contribute](https://openedx.
This project accepts all contributions, bug fixes, security fixes, maintenance work, or new features. However, please discuss your new feature idea with the maintainers before beginning development to maximize the chances of accepting your change. You can start a conversation by creating a new issue on this repo summarizing your idea.


== Screenshots ==



== Changelog ==

Expand Down
18 changes: 6 additions & 12 deletions openedx-woocommerce-plugin.php
Original file line number Diff line number Diff line change
@@ -1,17 +1,5 @@
<?php
/**
* The plugin bootstrap file
*
* This file is read by WordPress to generate the plugin information in the plugin
* admin area. This file also includes all of the dependencies used by the plugin,
* registers the activation and deactivation functions, and defines a function
* that starts the plugin.
*
* @link https://edunext.co/
* @since 1.0.0
* @package Openedx_Woocommerce_Plugin
*
* @wordpress-plugin
* Plugin Name: Open edX WooCommerce Plugin
* Plugin URI: https://github.com/eduNEXT/openedx-woocommerce-plugin
* Description: Easily connect your WooCommerce store to Open edX.
Expand All @@ -22,6 +10,12 @@
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
* Text Domain: openedx-woocommerce-plugin
* Domain Path: /languages
* Requires at least: 6.3
* Requires PHP: 8.0
*
* @package Openedx_Woocommerce_Plugin
*
* @wordpress-plugin
*/

use App\Openedx_Woocommerce_Plugin_Activator;
Expand Down

0 comments on commit e32f419

Please sign in to comment.