Merge pull request #1 from LinkNacional/dev

1.0.0 Plugin Launch

README.md

@@ -0,0 +1,40 @@
+# WooCommerce Invoice Payment
+
+WooCommerce Invoice Payment is an extension plugin for WooCommerce that aims to facilitate the management of invoices through the platform. It sends a new invoice email notification for the client and invoice creation with a direct payment link.
+
+## Dependencies
+
+WooCommerce Invoice Payment plugin is dependent on WooCommerce plugin, please make sure WooCommerce is installed and properly configured before starting WooCommerce Invoice Payment installation.
+
+
+## Installation
+
+1) Look in the sidebar for the WordPress plugins area;
+
+2) In installed plugins look for the 'add new' option in the header;
+
+3) Click on the 'submit plugin' option in the page title and upload the woocommerce-invoice-payment-main.zip plugin;
+
+4) Click on the 'install now' button and then activate the installed plugin;
+
+The WooCommerce Invoice Payment plugin is now live and working.
+
+## User instructions
+
+1) Search the WordPress sidebar for 'WooCommerce Invoice Payment';
+
+2) In the plugin options look for 'Add invoice';
+
+3) Fill in the customer data, currency, payment method and add the charges;
+
+4) If you want to send the invoice to the customer's email, select the 'Send invoice to customer' option in the invoice actions;
+
+5) Click save;
+
+You have created your first invoice with the WooCommerce Invoice Payment plugin.
+
+## Changelog
+
+### v1.0.0
+- Plugin launch.
+

README.txt

@@ -1,61 +1,47 @@
 === Plugin Name ===
-Contributors: (this should be a list of wordpress.org userid's)
-Donate link: https://www.linknacional.com/
-Tags: comments, spam
-Requires at least: 3.0.1
-Tested up to: 3.4
+Contributors: @linknacional
+Donate link: https://www.linknacional.com.br/wordpress/
+Tags: woocommerce, invoice, payment
+Requires at least: 4.7
+Tested up to: 5.9
 Stable tag: 4.3
+Requires PHP: 7.0
 License: GPLv2 or later
-License URI: http://www.gnu.org/licenses/gpl-2.0.html
+License URI: https://www.gnu.org/licenses/gpl-2.0.html
 
-Here is a short description of the plugin.  This should be no more than 150 characters.  No markup here.
+Invoice payment generation and management for WooCommerce.
 
 == Description ==
 
-This is the long description.  No limit, and you can use Markdown (as well as in the following sections).
+**Dependencies**
 
-For backwards compatibility, if this section is missing, the full length of the short description will be used, and
-Markdown parsed.
+WooCommerce Invoice Payment plugin is dependent on WooCommerce plugin, please make sure WooCommerce is installed and properly configured before starting WooCommerce Invoice Payment installation.
 
-A few notes about the sections above:
+**User instructions**
 
-*   "Contributors" is a comma separated list of wp.org/wp-plugins.org usernames
-*   "Tags" is a comma separated list of tags that apply to the plugin
-*   "Requires at least" is the lowest version that the plugin will work on
-*   "Tested up to" is the highest version that you've *successfully used to test the plugin*. Note that it might work on
-higher versions... this is just the highest one you've verified.
-*   Stable tag should indicate the Subversion "tag" of the latest stable version, or "trunk," if you use `/trunk/` for
-stable.
+1. Search the WordPress sidebar for 'WooCommerce Invoice Payment';
 
-    Note that the `readme.txt` of the stable tag is the one that is considered the defining one for the plugin, so
-if the `/trunk/readme.txt` file says that the stable tag is `4.3`, then it is `/tags/4.3/readme.txt` that'll be used
-for displaying information about the plugin.  In this situation, the only thing considered from the trunk `readme.txt`
-is the stable tag pointer.  Thus, if you develop in trunk, you can update the trunk `readme.txt` to reflect changes in
-your in-development version, without having that information incorrectly disclosed about the current stable version
-that lacks those changes -- as long as the trunk's `readme.txt` points to the correct stable tag.
+2. In the plugin options look for 'Add invoice';
 
-    If no stable tag is provided, it is assumed that trunk is stable, but you should specify "trunk" if that's where
-you put the stable version, in order to eliminate any doubt.
+3. Fill in the customer data, currency, payment method and add the charges;
 
-== Installation ==
+4. If you want to send the invoice to the customer's email, select the 'Send invoice to customer' option in the invoice actions;
 
-This section describes how to install the plugin and get it working.
+5. Click save;
 
-e.g.
+You have created your first invoice with the WooCommerce Invoice Payment plugin.
 
-1. Upload `boilerplate-wc.php` to the `/wp-content/plugins/` directory
-1. Activate the plugin through the 'Plugins' menu in WordPress
-1. Place `<?php do_action('plugin_name_hook'); ?>` in your templates
+== Installation ==
 
-== Frequently Asked Questions ==
+1. Look in the sidebar for the WordPress plugins area;
 
-= A question that someone might have =
+2. In installed plugins look for the 'add new' option in the header;
 
-An answer to that question.
+3. Click on the 'submit plugin' option in the page title and upload the woocommerce-invoice-payment-main.zip plugin;
 
-= What about foo bar? =
+4. Click on the 'install now' button and then activate the installed plugin;
 
-Answer to foo bar dilemma.
+The WooCommerce Invoice Payment plugin is now live and working.
 
 == Screenshots ==
 
@@ -67,48 +53,10 @@ directory take precedence. For example, `/assets/screenshot-1.png` would win ove
 
 == Changelog ==
 
-= 1.0 =
-* A change since the previous version.
-* Another change.
-
-= 0.5 =
-* List versions from most recent at top to oldest at bottom.
+= 1.0.0 =
+* Plugin launch.
 
 == Upgrade Notice ==
 
-= 1.0 =
+= 1.0.0 =
 Upgrade notices describe the reason a user should upgrade.  No more than 300 characters.
-
-= 0.5 =
-This version fixes a security related bug.  Upgrade immediately.
-
-== Arbitrary section ==
-
-You may provide arbitrary sections, in the same format as the ones above.  This may be of use for extremely complicated
-plugins where more information needs to be conveyed that doesn't fit into the categories of "description" or
-"installation."  Arbitrary sections will be shown below the built-in sections outlined above.
-
-== A brief Markdown Example ==
-
-Ordered list:
-
-1. Some feature
-1. Another feature
-1. Something else about the plugin
-
-Unordered list:
-
-* something
-* something else
-* third thing
-
-Here's a link to [WordPress](http://wordpress.org/ "Your favorite software") and one to [Markdown's Syntax Documentation][markdown syntax].
-Titles are optional, naturally.
-
-[markdown syntax]: http://daringfireball.net/projects/markdown/syntax
-            "Markdown is what the parser uses to process much of the readme file"
-
-Markdown uses email style notation for blockquotes and I've been told:
-> Asterisks for *emphasis*. Double it up  for **strong**.
-
-`<?php code(); // goes in backticks ?>`