Adding some usage documentation

diff --git a/glm-simple-messageboard.php b/glm-simple-messageboard.php
index f5ef0a2..6d13ea3 100644 (file)
--- a/glm-simple-messageboard.php
+++ b/glm-simple-messageboard.php
@@ -7,6 +7,35 @@
  * Author URI: http://www.gaslightmedia.com
  * License: All right reserved
  */
+
+/*
+ * USAGE:       
+ *          
+    This part goes into your functions.php
+                <?php                    
+                    if ( !function_exists( 'glm_get_simplemessageboard_option' ) ) {
+                        function glm_get_simplemessageboard_option( $option_name )
+                        {
+                            $settings = get_option( 'glmsimplemessageboard_settings' );
+                            return ( $settings && $settings[$option_name] )
+                                ? $settings[$option_name]
+                                : null;
+                        }
+                    }
+                ?>
+ * 
+    This part goes where you want to display the data
+            <div>
+                <?php if (function_exists( 'glm_get_simplemessageboard_option' ) ) {?>
+                    <span> <?php echo glm_get_simplemessageboard_option( 'title' );?></span>
+                    <?php if ( glm_get_simplemessageboard_option( 'message' ) ) {?>
+                        <span><?php echo glm_get_simplemessageboard_option( 'message' );?></span>
+                    <?php } ?>
+                <?php } ?>
+
+            </div>
+ */
+
 define('GLM_SIMPLEMESSAGEBOARD_SETTINGS', 'glmsimplemessageboard_settings');
 define('GLM_NEW_CAPABILITY', 'glmsimplemessageboard_edit_messageboard');
 define('BUILT_IN_CAPABILITY', 'edit_posts');