Merge pull request #325 from pattonwebz/master

Slight readme tweaks

Author: bhubbard

README.md

@@ -12,7 +12,7 @@ A custom WordPress nav walker class to fully implement the Bootstrap 3.0+ naviga
 
 ## NOTES
 
-This is a utility class that is intended to format your WordPress theme menu with the correct syntax and classes to utilize the Bootstrap dropdown navigation, and does not include the required Bootstrap JS files. You will have to include them manually.
+This is a utility class that is intended to format your WordPress theme menu with the correct syntax and classes to utilize the Bootstrap dropdown navigation. It does not include the required Bootstrap JS and CSS files. You will have to include those dependancies seporately.
 
 ### Bootstrap 4
 
@@ -29,13 +29,15 @@ Place **wp-bootstrap-navwalker.php** in your WordPress theme folder `/wp-content
 Open your WordPress themes **functions.php** file  `/wp-content/your-theme/functions.php` and add the following code:
 
 ```php
+<?php
 // Register Custom Navigation Walker
 require_once get_template_directory() . '/wp-bootstrap-navwalker.php';
 ```
 
 If you encounter errors with the above code use a check like this to return clean errors to help diagnose the problem.
 
 ```php
+<?php
 if ( ! file_exists( get_template_directory() . '/wp-bootstrap-navwalker.php' ) ) {
 	// file does not exist... return an error.
 	return new WP_Error( 'wp-bootstrap-navwalker-missing', __( 'It appears the wp-bootstrap-navwalker.php file may be missing.', 'wp-bootstrap-navwalker' ) );
@@ -50,61 +52,58 @@ if ( ! file_exists( get_template_directory() . '/wp-bootstrap-navwalker.php' ) )
 Update your `wp_nav_menu()` function in `header.php` to use the new walker by adding a "walker" item to the wp_nav_menu array.
 
 ```php
- <?php
-            wp_nav_menu( array(
-                'menu'              => 'primary',
-                'theme_location'    => 'primary',
-                'depth'             => 2,
-                'container'         => 'div',
-                'container_class'   => 'collapse navbar-collapse',
-                'container_id'      => 'bs-example-navbar-collapse-1',
-                'menu_class'        => 'nav navbar-nav',
-                'fallback_cb'       => 'WP_Bootstrap_Navwalker::fallback',
-                'walker'            => new WP_Bootstrap_Navwalker())
-            );
-        ?>
+<?php
+wp_nav_menu( array(
+    'theme_location'    => 'primary',
+    'depth'             => 2,
+    'container'         => 'div',
+    'container_class'   => 'collapse navbar-collapse',
+    'container_id'      => 'bs-example-navbar-collapse-1',
+    'menu_class'        => 'nav navbar-nav',
+    'fallback_cb'       => 'WP_Bootstrap_Navwalker::fallback',
+    'walker'            => new WP_Bootstrap_Navwalker())
+);
 ```
 
 Your menu will now be formatted with the correct syntax and classes to implement Bootstrap dropdown navigation.
 
-You will also want to declare your new menu in your `functions.php` file.
+You will also want to declare your new menu in your `functions.php` file if one is not already defined.
 
 ```php
+<?php
 register_nav_menus( array(
-        'primary' => __( 'Primary Menu', 'THEMENAME' ),
+    'primary' => __( 'Primary Menu', 'THEMENAME' ),
 ) );
 ```
 
 Typically the menu is wrapped with additional markup, here is an example of a ` navbar-fixed-top` menu that collapse for responsive navigation.
 
 ```php
 <nav class="navbar navbar-default" role="navigation">
-  <div class="container-fluid">
-    <!-- Brand and toggle get grouped for better mobile display -->
-    <div class="navbar-header">
-      <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
-        <span class="sr-only">Toggle navigation</span>
-        <span class="icon-bar"></span>
-        <span class="icon-bar"></span>
-        <span class="icon-bar"></span>
-      </button>
-      <a class="navbar-brand" href="<?php echo home_url(); ?>">
-                <?php bloginfo('name'); ?>
-            </a>
-    </div>
-
+	<div class="container-fluid">
+		<!-- Brand and toggle get grouped for better mobile display -->
+		<div class="navbar-header">
+			<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
+				<span class="sr-only">Toggle navigation</span>
+        		<span class="icon-bar"></span>
+        		<span class="icon-bar"></span>
+        		<span class="icon-bar"></span>
+			</button>
+    		<a class="navbar-brand" href="<?php echo home_url(); ?>">
+				<?php bloginfo('name'); ?>
+        	</a>
+		</div>
         <?php
-            wp_nav_menu( array(
-                'menu'              => 'primary',
-                'theme_location'    => 'primary',
-                'depth'             => 2,
-                'container'         => 'div',
-                'container_class'   => 'collapse navbar-collapse',
-                'container_id'      => 'bs-example-navbar-collapse-1',
-                'menu_class'        => 'nav navbar-nav',
-                'fallback_cb'       => 'WP_Bootstrap_Navwalker::fallback',
-                'walker'            => new WP_Bootstrap_Navwalker())
-            );
+        wp_nav_menu( array(
+            'theme_location'    => 'primary',
+            'depth'             => 2,
+            'container'         => 'div',
+            'container_class'   => 'collapse navbar-collapse',
+            'container_id'      => 'bs-example-navbar-collapse-1',
+            'menu_class'        => 'nav navbar-nav',
+            'fallback_cb'       => 'WP_Bootstrap_Navwalker::fallback',
+            'walker'            => new WP_Bootstrap_Navwalker())
+        );
         ?>
     </div>
 </nav>
@@ -117,13 +116,14 @@ Review options in the Bootstrap docs for more information on [nav classes](https
 
 ### Displaying the Menu
 
-To display the menu you must associate your menu with your theme location. You can do this by selecting your theme location in the *Theme Locations* list wile editing a menu in the WordPress menu manager.
+To display the menu you must associate your menu with your theme location. You can do this by selecting your theme location in the *Theme Locations* list while editing a menu in the WordPress menu manager.
 
 ### Making this Walker the Default Walker for Nav Manus
 
 There has been some interest in making this walker the default walker for all menus. That could result in some unexpected situations but it can be achieved by adding this function to your functions.php file.
 
 ```php
+<?php
 function prefix_modify_nav_menu_args( $args ) {
     return array_merge( $args, array(
         'walker' => WP_Bootstrap_Navwalker(),
@@ -135,24 +135,24 @@ Simply updating the walker may not be enough to get menus working right, you may
 
 ### Extras
 
-This script included the ability to add Bootstrap dividers, dropdown headers, glyphicons and disables links to your menus through the WordPress menu UI.
+This script included the ability to add Bootstrap dividers, dropdown headers, glyphicons and disabled links to your menus through the WordPress menu UI.
 
-### Dividers
+#### Dividers
 
 Simply add a Link menu item with a **URL** of `#` and a **Link Text** or **Title Attribute** of `divider` (case-insensitive so ‘divider’ or ‘Divider’ will both work ) and the class will do the rest.
 
-### Glyphicons
+#### Glyphicons
 
 To add an Icon to your link simple place the Glyphicon class name in the links **Title Attribute** field and the class will do the rest. IE `glyphicon-bullhorn`
 
-### Dropdown Headers
+#### Dropdown Headers
 
 Adding a dropdown header is very similar, add a new link with a **URL** of `#` and a **Title Attribute** of `dropdown-header` (it matches the Bootstrap CSS class so it's easy to remember).  set the **Navigation Label** to your header text and the class will do the rest.
 
-### Disabled Links
+#### Disabled Links
 
 To set a disabled link simply set the **Title Attribute** to `disabled` and the class will do the rest.
 
-### Changelog
+## Changelog
 
 Please see the [Changelog](https://github.com/wp-bootstrap/wp-bootstrap-navwalker/blob/master/CHANGELOG.md).