the first public release 😄

README.md

@@ -1,8 +1,16 @@
-# WordPress-J-QueryFilter
+# Query Filter #
+
+* **Contributors:** [marsjaninzmarsa] (http://profiles.wordpress.org/marsjaninzmarsa), [mainpagepl] (http://profiles.wordpress.org/mainpagepl),
+
+* **License:** [GPL v3 or later] (http://www.gnu.org/licenses/gpl-3.0.html)
+
+Advanced taxonomy and Custom Fields CPT filtering plugin.
+
+## Description ##
 
 Plugin for advanced filtering of site content by taxonomies and custom fields. If you have portfolio site and need to give users power of filtering items by topic and year, or photoblog with hundreds of photos categorized by colors, place and photographer, or even shop with bikes various type, vendor and price - this is something for you. You can setup filtering of any Post Type by any tax or meta parameter, text or numeric and display to your visitors fancy and configurable filtering widget.
 
-## Functions
+#### Functions ####
 
 * Support for any Post Type on site and any theme - if you can display it, you can filter it
 * Support for any Taxonomy and any Custom Field - if you have post with it, you can filter by it
@@ -12,9 +20,46 @@ Plugin for advanced filtering of site content by taxonomies and custom fields. I
 * Easy to use for every user
 * Fully extendable and customizable for developers (AJAX? No problem. Filtering of users or comments? Even easier)
 
-## Todo
+#### Todo ####
 
 * Fancy, drag'n'drop filter form configuration
 * Full and out of the box support for filtering by text, range (with or without slider) and date
 * More build in themes (Pro?)
-* AJAX support for every theme (Pro?)
+* AJAX support for every theme (Pro?)
+
+## Installation ##
+
+1. Upload `j-query-filter/` to the `/wp-content/plugins/` directory
+2. Activate the plugin through the 'Plugins' menu in WordPress
+3. Add new Widget to desired Widget Area and set options
+4. Enjoy. 😄
+
+## Frequently Asked Questions ##
+
+#### I can't choose any Post Type to filtering ####
+
+Do you have any? Plugin currently allows only to choose Post Type which is public and have archive (relays on archive template when displaying results). It may going to change in future releases.
+
+#### What is this weird "Filtering parameters" thing? How to deal with it? ####
+
+It's YAML representation of filtering parameters, [schema for it is in the code](https://github.com/marsjaninzmarsa/WordPress-J-QueryFilter/blob/master/schema.yaml), more detailed how-to is on the way. It is going to change in future releases to more user-friendly, drag'n'drop visual interface.
+
+#### You have AJAX working on your demo, I don't, how to live, what to do?  ####
+
+If you are developer, you can adapt your Theme to support it, demo code on the way. If you aren't and you don't understand what happen if you press Ctrl+U, you must hire one for it. It is going to change in future releases.
+
+#### Why not foo/bar from todo list not in plugin yet? ####
+
+Cause lack of time. You may donate me, I think, if you wanna, then I may have more time (currently you must contact me via [my profile](https://profiles.wordpress.org/marsjaninzmarsa) first).
+
+#### Why not foo/bar on your todo list? ####
+
+Cause I don't thought about if yet? Feel free to [contact me](https://profiles.wordpress.org/marsjaninzmarsa) with suggestion or [open a Issue on GitHub](https://github.com/marsjaninzmarsa/WordPress-J-QueryFilter/issues). 
+
+## Screenshots ##
+
+Coming soon...
+
+## Advanced integration ##
+
+Coming soon...

deploy.sh

@@ -35,11 +35,13 @@ echo ".........................................."
 echo
 
 # Check version in readme.txt is the same as plugin file
-NEWVERSION1=`grep "^Stable tag" $GITPATH/readme.txt | awk -F' ' '{print $3}'`
+NEWVERSION1=`grep "^Stable tag" $GITPATH/readme.txt | awk -F' ' '{print $3}' | tr -d '\r'`
 echo "readme version: $NEWVERSION1"
 #NEWVERSION2=`grep "^Version" $GITPATH/$MAINFILE | awk -F' ' '{print $2}'`
-NEWVERSION2=`grep -i "Version" $GITPATH/$MAINFILE | head -n1 | awk -F':' '{print $2}' | awk -F' ' '{print $1}'`
+NEWVERSION2=`grep -i "Version" $GITPATH/$MAINFILE | head -n1 | awk -F':' '{print $2}' | awk -F' ' '{print $1}' | tr -d '\r'`
 echo "$MAINFILE version: $NEWVERSION2"
+echo `od -a <<< "$NEWVERSION1"` > v1.txt
+echo `od -a <<< "$NEWVERSION2"` > v2.txt
 
 if [ "$NEWVERSION1" != "$NEWVERSION2" ]; then echo "Versions don't match. Exiting...."; exit 1; fi