-
Notifications
You must be signed in to change notification settings - Fork 3
/
readme.txt
81 lines (55 loc) · 4.47 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
=== WooCommerce Subscription Shortcodes ===
Contributors: sebd86
Tags: woocommerce, subscriptions, subscribe, order, cart, product, product type, extension, short, shortcode, shortcodes
Donate Link: https://www.paypal.com/cgi-bin/webscr?cmd=_xclick&[email protected]¤cy_code=&amount=&return=&item_name=Donation+for+WooCommerce+Subscription+Shortcodes
Requires at least: 4.1
Tested up to: 4.5.3
Stable tag: 1.0.0 Beta
WC requires at least: 2.3
WC tested up to: 2.6.3
License: GNU General Public License v3.0
License URI: http://www.gnu.org/licenses/gpl-3.0.html
Provides shortcodes that you can use to add details about the subscription product where you want them to be.
== Description ==
Provides shortcodes that you can use to add details about the subscription product where you want them to be. Either to be used in a custom theme for your single product pages or use them in your blog to talk about a product you are selling.
> #### Please note
> Due to the size of **[WooCommerce Subscriptions](https://woocommerce.com/products/woocommerce-subscriptions/)** and it's experimental extension **[WooCommerce Subscribe All the Things](https://github.com/Prospress/woocommerce-subscribe-all-the-things)**, this plugin is in beta and requires your feedback to make sure everything is stable. So far there is only one shortcode that is still in development.
> Tests so far shows all other shortcodes are working fine.
= Requirements =
In order to use this extension, you will need the follow:
* WooCommerce 2.3 or newer.
* WooCommerce Subscriptions v2.0 or newer.
* A staging or test site, I do not recommend using this on live sites yet.
* A sense of adventure as the codebase is still beta.
= Support =
As this is a free plugin I can not provide support. I recommend you ask the community for support should you need it.
= Contributing =
If you have a patch, or stumbled upon an issue with the shortcodes, you can contribute this back to the code. Please read the [contributor guidelines](https://github.com/seb86/WooCommerce-Subscription-Shortcodes/blob/master/CONTRIBUTING.md) for more information on how you can do this.
= Credits =
[Prospress](http://prospress.com/) are the developers of the [WooCommerce Subscriptions](https://woocommerce.com/products/woocommerce-subscriptions/) extension and [WooCommerce Subscribe All the Things](https://github.com/Prospress/woocommerce-subscribe-all-the-things) mini-extension.
This project was backed by [Subscription Group Limited](http://www.subscriptiongroup.co.uk/).
= Disclaimers =
The WooCommerce logo and the WooCommerce name are trademarks of Automattic Inc. No affiliation or endorsement of this plugin by Automattic is intended or implied.
== Installation ==
To install the Subscription Shortcodes:
1. Download the latest version of the plugin here
2. Go to Plugins > Add New > Upload administration screen on your WordPress site
3. Select the ZIP file you just downloaded
4. Click Install Now
5. Click Activate
6. After installation, you can use the shortcodes listed below.
== Other Notes ==
= Shortcode Usage =
Simply insert the shortcode you wish to use on the product page or blog post or even a standard page. If you use the shortcode outside of the product page then you will need to add the product ID attribute or the sku ID attribute.
> Example: `[subscription_price id="123"]` or `[subscription_price sku="123"]`
A full list of the shortcodes can be found [here](https://github.com/seb86/WooCommerce-Subscription-Shortcodes).
### More Information
* [How to use shortcodes](https://codex.wordpress.org/Shortcode)
* [How to insert shorcodes into your templates](https://developer.wordpress.org/reference/functions/do_shortcode/#user-contributed-notes)
In order to show details for sign up fee, trial length and trial period of a product using [WooCommerce Subscribe All the Things](https://github.com/Prospress/woocommerce-subscribe-all-the-things) you will need to also have [WooCommerce Subscribe All the Things - Sign-up and Trial Add-on](https://github.com/seb86/woocommerce-subscribe-to-all-the-things-signup-trial-add-on) installed.
- Other [WordPress plugins](http://profiles.wordpress.org/sebd86/) by [Sébastien Dumont](https://sebastiendumont.com)
- Contact Sébastien on Twitter: [@sebd86](http://twitter.com/sebd86)
- If you're a developer yourself, follow or contribute to the [WooCommerce Subscription Shortcodes plugin on GitHub](https://github.com/seb86/WooCommerce-Subscription-Shortcodes)
== Changelog ==
= 1.0.0 Beta - 22/07/2016 =
* Initial release