Merge origin/master

Askupa Software · Askupa Software · commit 2982a9c52b49 · 2016-03-31T10:47:56.000-05:00
diff --git a/README.md b/README.md
@@ -26,10 +26,13 @@ A library for generating static stylesheets from dynamic content, to be used in
 * [Enqueueing Dynamic Stylesheets](#enqueueing-dynamic-stylesheets)
     * [Loading the Compiled CSS as an External Stylesheet](#loading-the-compiled-css-as-an-external-stylesheet)
 * [Setting the Value Callback](#setting-the-value-callback)
+* [API Reference](#api-reference)
+    * [wp_dynamic_css_enqueue](#wp_dynamic_css_enqueue)
+    * [wp_dynamic_css_set_callback](#wp_dynamic_css_set_callback)
 
 ## Overview
 
-**WordPress Dynamic CSS** is a lightweight library for generating CSS stylesheets from dynamic content (i.e. content that can be modified by the user). The most obvious use case for this library is for creating stylesheets based on Customizer options. Using the special dynamic CSS syntax you can write CSS rules with variables that will be replaced by static values using a custom callback function that you provide.
+**WordPress Dynamic CSS** is a lightweight library for generating CSS stylesheets from dynamic content (i.e. content that can be modified by the user). The most obvious use case for this library is for creating stylesheets based on Customizer options. Using the special dynamic CSS syntax you can write CSS rules with variables that will be replaced by static values using a custom callback function that you provide.  
 **As of version 1.0.2** this library supports multiple callback functions, thus making it safe to use by multiple plugins/themes at the same time.
 
 ### Basic Example
@@ -53,7 +56,7 @@ wp_dynamic_css_set_callback( 'my_dynamic_style', 'my_dynamic_css_callback' );
 // 4. Nope, only three steps
 ```
 
-Then, create a file called `my-style.css` and write this in it:
+Then, create a file called `my-style.css` and write your (dynamic) CSS in it:
 
 ```css
 body {
@@ -201,6 +204,37 @@ body {
 }
 ```
 
+## API Reference
+
+### wp_dynamic_css_enqueue
+
+*Enqueue a dynamic stylesheet*
+
+```php 
+function wp_dynamic_css_enqueue( $handle, $path, $print = true )
+```
+
+This function will either print the compiled version of the stylesheet to the document's <head> section, or load it as an external stylesheet if `$print` is set to false.
+
+**Parameters**
+* `$handle` (*string*) The stylesheet's name/id
+* `$path` (*string*) The absolute path to the dynamic CSS file
+* `$print` (*boolean*) Whether to print the compiled CSS to the document head, or load it as an external CSS file via an http request
+
+### wp_dynamic_css_set_callback
+
+*Set the value retrieval callback function*
+
+```php 
+function wp_dynamic_css_set_callback( $handle, $callback )
+```
+
+Set a callback function that will be used to convert variables to actual values. The registered function will be used when the dynamic CSS file that is associated with the name in `$handle` is compiled. The callback function accepts 1 parameter which is the name of the variable, without the $ sign.
+
+**Parameters**
+* `$handle` (*string*) The name of the stylesheet to be associated with this callback function.
+* `$callback` (*callable*) A callback (or "callable" as of PHP 5.4) can either be a reference to a function name or method within a class/object.
+
 ## TODO
 
 * ~~Add support for loading the compiled CSS externally instead of printing to the document head~~ (Added in 1.0.1)
diff --git a/bootstrap.php b/bootstrap.php
@@ -13,7 +13,7 @@
  * Plugin Name:     WordPress Dynamic CSS
  * Plugin URI:      https://github.com/askupasoftware/wp-dynamic-css
  * Description:     Dynamic CSS compiler for WordPress
- * Version:         1.0.1
+ * Version:         1.0.2
  * Author:          Askupa Software
  * Author URI:      http://www.askupasoftware.com
  * Text Domain:     wp-dynamic-css
diff --git a/functions.php b/functions.php
@@ -13,8 +13,8 @@
      * Enqueue a dynamic stylesheet
      * 
      * This will either print the compiled version of the stylesheet to the 
-     * document's <head> section, or load it as an external stylesheet if the 
-     * second parameter is set to false
+     * document's <head> section, or load it as an external stylesheet if $print 
+     * is set to false
      * 
      * @param string $handle The stylesheet's name/id
      * @param string $path The absolute path to the dynamic CSS file
@@ -48,4 +48,4 @@ function wp_dynamic_css_set_callback( $handle, $callback )
         $dcss = DynamicCSSCompiler::get_instance();
         $dcss->register_callback( $handle, $callback );
     }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -13,8 +13,8 @@`
`13`	`13`	`* Enqueue a dynamic stylesheet`
`14`	`14`	`*`
`15`	`15`	`* This will either print the compiled version of the stylesheet to the`
`16`		`- * document's <head> section, or load it as an external stylesheet if the`
`17`		`- * second parameter is set to false`
	`16`	`+ * document's <head> section, or load it as an external stylesheet if $print`
	`17`	`+ * is set to false`
`18`	`18`	`*`
`19`	`19`	`* @param string $handle The stylesheet's name/id`
`20`	`20`	`* @param string $path The absolute path to the dynamic CSS file`
`@@ -48,4 +48,4 @@ function wp_dynamic_css_set_callback( $handle, $callback )`
`48`	`48`	`$dcss = DynamicCSSCompiler::get_instance();`
`49`	`49`	`$dcss->register_callback( $handle, $callback );`
`50`	`50`	`}`
`51`		`-}`
	`51`	`+}`