clean up readme, bump to v0.1.12

pushandplay · Mar 9, 2016 · 4560ff2 · 4560ff2
1 parent 40817bd
commit 4560ff2
Show file tree

Hide file tree

Showing 6 changed files with 105 additions and 163 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,5 @@ tmp
 AppRateDemoProject
 www_app
 node_modules
-AppRateDemoProject
+AppRateDemoProject
+npm-debug.log
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,8 @@
+# Changelog
+
+- 0.1.12
+  - Bump version to be higher than the previous `cordova-plugin-apprate` on the NPM registry
+  - Clean up readme
+- 0.1.9
+  - Update id to `cordova-plugin-apprate` and update dependencies
+  - Add finnish locale
diff --git a/NOTICE b/NOTICE
diff --git a/README.md b/README.md
@@ -1,54 +1,40 @@
-# AppRate Cordova/Phonegap plugin #
+# cordova-plugin-apprate
 
 This plugin provide the rate this app functionality into your Cordova/Phonegap application<br>
 
-Issues list and features requests [here](https://github.com/pushandplay/cordova-plugin-apprate/issues?state=open)
-
 [Donate with PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=MS8RQAS2NVVQW&lc=RU&item_name=github%2ecom&item_number=cordova%2dplugin%2dapprate&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted)
 
 <img src="https://dl.dropboxusercontent.com/u/26238/Cordova/Plugins/AppRate/preview_iPad.png" width="100%" alt="Preview iPad"/>
 
-### Read before implementation ###
+### Some Articles on the Importance of App Reviews and Ratings ###
 
 + [Begging For App Ratings](http://www.loopinsight.com/2014/02/04/begging-for-app-ratings/)
 + [Choices And Consequences](http://bitsplitting.org/2013/12/11/choices-and-consequences/)
 + [The importance of App Store reviews](http://www.cowlyowl.com/blog/app-store-reviews)
 + [The Rate Friday Initiative](http://blog.edovia.com/2014/01/03/the-rate-friday-initiative/)
 + [Prompting for App Reviews](http://dancounsell.com/articles/prompting-for-app-reviews)
 
-### Read before writing review ###
-
-+ [FAQ](https://github.com/pushandplay/cordova-plugin-apprate/wiki)
-
 ## Supported platforms ##
 
-+	iOS
-+	Android
-+	Blackberry (experimental)
-+	Windows8 (experimental)
+- iOS
+- Android
+- Blackberry (experimental)
+- Windows8 (experimental)
 
 ## Requirements ##
 
 Phonegap / Cordova 3.0.0 or later
 
 ## Installation ##
 
-+	From github repository:
-
-		cordova plugins add https://github.com/pushandplay/cordova-plugin-apprate.git
-			
-+	From apache cordova plugins registry:
-
-		cordova plugins add org.pushandplay.cordova.apprate
-		
-+	From phonegap build add the following to your config.xml:
-
-		<gap:plugin name="org.pushandplay.cordova.apprate" />
+- From apache cordova plugins registry: `cordova plugins add cordova-plugin-apprate`
+- From github repository:	`cordova plugins add https://github.com/pushandplay/cordova-plugin-apprate.git`
+- From phonegap build add the following to your config.xml: `<gap:plugin name="cordova-plugin-apprate" />`
 
 ## Customization and usage ##
 
 #### Note ####
-All %@ patterns in customLocale object will be automatically replaced to your application title
+All `%@` patterns in customLocale object will be automatically replaced to your application title
 
 #### Available preferences options ####
 
@@ -70,101 +56,108 @@ All %@ patterns in customLocale object will be automatically replaced to your ap
 
 #### Simple setup and call ####
 
-    AppRate.preferences.storeAppURL.ios = '<my_app_id>';
-    AppRate.preferences.storeAppURL.android = 'market://details?id=<package_name>';
-    AppRate.preferences.storeAppURL.blackberry = 'appworld://content/[App Id]/';
-    AppRate.preferences.storeAppURL.windows8 = 'ms-windows-store:Review?name=<the Package Family Name of the application>';
-    AppRate.promptForRating();
+```javascript
+  AppRate.preferences.storeAppURL.ios = '<my_app_id>';
+  AppRate.preferences.storeAppURL.android = 'market://details?id=<package_name>';
+  AppRate.preferences.storeAppURL.blackberry = 'appworld://content/[App Id]/';
+  AppRate.preferences.storeAppURL.windows8 = 'ms-windows-store:Review?name=<the Package Family Name of the application>';
+  AppRate.promptForRating();
+```
 
-#### Call rate dialog immediately ####
+#### Don't Call rate dialog immediately ####
 
-	AppRate.preferences.storeAppURL.ios = '<my_app_id>';
-	AppRate.promptForRating(true);
+```javascript
+AppRate.preferences.storeAppURL.ios = '<my_app_id>';
+AppRate.promptForRating(false);
+```
 
 #### Override dialog button callback ####
 
-	var onButtonClicked = function(buttonIndex) {
-		console.log("onButtonClicked -> " + buttonIndex);
-	};
+```javascript
+var onButtonClicked = function(buttonIndex) {
+  console.log("onButtonClicked -> " + buttonIndex);
+};
 
-	AppRate.preferences.storeAppURL.ios = '<my_app_id>';
-	AppRate.preferences.storeAppURL.android = 'market://details?id=<package_name>';
-	AppRate.preferences.callbacks.onButtonClicked = onButtonClicked;
-	AppRate.promptForRating();
+AppRate.preferences.storeAppURL.ios = '<my_app_id>';
+AppRate.preferences.storeAppURL.android = 'market://details?id=<package_name>';
+AppRate.preferences.callbacks.onButtonClicked = onButtonClicked;
+AppRate.promptForRating();
+```
 		
 #### Set custom language ####
 
-	AppRate.preferences.useLanguage = 'ru';
-	AppRate.preferences.storeAppURL.ios = '<my_app_id>';
-	AppRate.preferences.storeAppURL.android = 'market://details?id=<package_name>';
-	AppRate.promptForRating();
+```javascript
+AppRate.preferences.useLanguage = 'ru';
+AppRate.preferences.storeAppURL.ios = '<my_app_id>';
+AppRate.preferences.storeAppURL.android = 'market://details?id=<package_name>';
+AppRate.promptForRating();
+```
 
 #### Set custom Locale object ####
 
-	var customLocale = {};
-	customLocale.title = "Rate %@";
-	customLocale.message = "If you enjoy using %@, would you mind taking a moment to rate it? It won’t take more than a minute. Thanks for your support!";
-	customLocale.cancelButtonLabel = "No, Thanks";
-	customLocale.laterButtonLabel = "Remind Me Later";
-	customLocale.rateButtonLabel = "Rate It Now";
+```javascript
+var customLocale = {};
+customLocale.title = "Rate %@";
+customLocale.message = "If you enjoy using %@, would you mind taking a moment to rate it? It won’t take more than a minute. Thanks for your support!";
+customLocale.cancelButtonLabel = "No, Thanks";
+customLocale.laterButtonLabel = "Remind Me Later";
+customLocale.rateButtonLabel = "Rate It Now";
 
-	AppRate.preferences.storeAppURL.ios = '<my_app_id>';
-	AppRate.preferences.storeAppURL.android = 'market://details?id=<package_name>';
-	AppRate.preferences.customLocale = customLocale;
-	AppRate.promptForRating();
+AppRate.preferences.storeAppURL.ios = '<my_app_id>';
+AppRate.preferences.storeAppURL.android = 'market://details?id=<package_name>';
+AppRate.preferences.customLocale = customLocale;
+AppRate.promptForRating();
+```
 
 #### Full setup ####
 
-	var customLocale = {};
-	customLocale.title = "Rate %@";
-	customLocale.message = "If you enjoy using %@, would you mind taking a moment to rate it? It won’t take more than a minute. Thanks for your support!";
-	customLocale.cancelButtonLabel = "No, Thanks";
-	customLocale.laterButtonLabel = "Remind Me Later";
-	customLocale.rateButtonLabel = "Rate It Now";
-
-	AppRate.preferences.openStoreInApp = true;
-	AppRate.preferences.storeAppURL.ios = '<my_app_id>';
-	AppRate.preferences.storeAppURL.android = 'market://details?id=<package_name>';
-	AppRate.preferences.customLocale = customLocale;
-	AppRate.preferences.displayAppName = 'My custom app title';
-	AppRate.preferences.usesUntilPrompt = 5;
-	AppRate.preferences.promptAgainForEachNewVersion = false;
-	AppRate.promptForRating();
+```javascript
+var customLocale = {};
+customLocale.title = "Rate %@";
+customLocale.message = "If you enjoy using %@, would you mind taking a moment to rate it? It won’t take more than a minute. Thanks for your support!";
+customLocale.cancelButtonLabel = "No, Thanks";
+customLocale.laterButtonLabel = "Remind Me Later";
+customLocale.rateButtonLabel = "Rate It Now";
+
+AppRate.preferences.openStoreInApp = true;
+AppRate.preferences.storeAppURL.ios = '<my_app_id>';
+AppRate.preferences.storeAppURL.android = 'market://details?id=<package_name>';
+AppRate.preferences.customLocale = customLocale;
+AppRate.preferences.displayAppName = 'My custom app title';
+AppRate.preferences.usesUntilPrompt = 5;
+AppRate.preferences.promptAgainForEachNewVersion = false;
+AppRate.promptForRating();
+```
 
 #### Callbacks setup and use custom rate-dialog ####
 
-	var onRateDialogShow = function(callback) {
-		console.log("onRateDialogShow");
-		//	call this callback when user click on button into your custom rate-dialog
-		//	for example: simulate click on "Rate now" button and display store
-		callback(3)
-	};
-	var onButtonClicked = function(buttonIndex) {
-		console.log("onButtonClicked -> " + buttonIndex);
-	};
-
-	AppRate.preferences.storeAppURL.ios = '<my_app_id>';
-	AppRate.preferences.useCustomRateDialog = true;
-	AppRate.preferences.callbacks.onRateDialogShow = onRateDialogShow;
-	AppRate.preferences.callbacks.onButtonClicked = onButtonClicked;
-
-	//	True param show rate-dialog immediately and useful for testing or custom logic
-	AppRate.promptForRating(true);
+```javascript
+var onRateDialogShow = function(callback) {
+  //call this callback when user click on button into your custom rate-dialog for example: simulate click on "Rate now" button and display store
+  console.log("onRateDialogShow");
+  callback(3)
+};
+var onButtonClicked = function(buttonIndex) {
+  console.log("onButtonClicked -> " + buttonIndex);
+};
+
+AppRate.preferences.storeAppURL.ios = '<my_app_id>';
+AppRate.preferences.useCustomRateDialog = true;
+AppRate.preferences.callbacks.onRateDialogShow = onRateDialogShow;
+AppRate.preferences.callbacks.onButtonClicked = onButtonClicked;
+
+AppRate.promptForRating();
+```
 		
 ## Already included translations ##
-ar, bn, ca, cs, da, de, de-AT, el, en, es, fa, fr, he, hi, id, il, ja, ko, nl, no, pa, pl, pt, ru, sk, sl, sv, th, tr, uk, ur, ur-IN, ur-PK, vi, zh-TW, zh-Hans, zh-Hant
+https://github.com/pushandplay/cordova-plugin-apprate/blob/master/www/locales.js
 
 #### Access to locales ####
 
-	//	Getting list of names for available locales
-	AppRate.locales.getLocalesNames();
-
-	//	Getting locale object by name
-	AppRate.locales.getLocale('en');
-
-You can add a new translation here: [https://crowdin.net/project/apprate-cordovaphonegap-plugin](https://crowdin.net/project/apprate-cordovaphonegap-plugin)
-
-
-## Licence ##
+```javascript
+// Getting list of names for available locales
+AppRate.locales.getLocalesNames();
 
-The Apache 2.0 License
+// Getting locale object by name
+AppRate.locales.getLocale('en');
+```
diff --git a/RELEASENOTES.md b/RELEASENOTES.md
diff --git a/package.json b/package.json
@@ -1,6 +1,10 @@
 {
   "name": "cordova-plugin-apprate",
-  "version": "0.1.9",
+  "version": "0.1.12",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pushandplay/cordova-plugin-apprate"
+  },
   "dependencies": {
     "cordova": "*",
     "grunt": "*",