RubyGems - rbcli - Versions diffs - 0.2.10 → 0.3.1 - Mend

rbcli 0.2.10 → 0.3.1

Files changed (444) hide show

data/docs/development/contributing/index.html CHANGED Viewed

@@ -1,795 +1,1201 @@
+<!DOCTYPE html>
+<html lang="en" class="js csstransforms3d">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta name="generator" content="Hugo 0.88.1" />
+    <meta name="description" content="">
+    <link rel="icon" href="/rbcli/images/favicon.png" type="image/png">
+    <title>Contribution Guide :: RBCli Documentation</title>
-<!DOCTYPE html>
-<html lang="en" class="no-js">
-  <head>
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      <meta http-equiv="x-ua-compatible" content="ie=edge">
-        <meta name="description" content="Description">
-        <meta name="author" content="Andrew Khoury">
-        <meta name="lang:clipboard.copy" content="Copy to clipboard">
-        <meta name="lang:clipboard.copied" content="Copied to clipboard">
-        <meta name="lang:search.language" content="en">
-        <meta name="lang:search.pipeline.stopwords" content="True">
-        <meta name="lang:search.pipeline.trimmer" content="True">
-        <meta name="lang:search.result.none" content="No matching documents">
-        <meta name="lang:search.result.one" content="1 matching document">
-        <meta name="lang:search.result.other" content="# matching documents">
-        <meta name="lang:search.tokenizer" content="[\s\-]+">
-      <link rel="shortcut icon" href="../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.0.3, mkdocs-material-3.0.4">
-        <title>Contribution Guide - RBCli Documentation</title>
+    <link href="/rbcli/css/nucleus.css?1634703589" rel="stylesheet">
+    <link href="/rbcli/css/fontawesome-all.min.css?1634703589" rel="stylesheet">
+    <link href="/rbcli/css/hybrid.css?1634703589" rel="stylesheet">
+    <link href="/rbcli/css/featherlight.min.css?1634703589" rel="stylesheet">
+    <link href="/rbcli/css/perfect-scrollbar.min.css?1634703589" rel="stylesheet">
+    <link href="/rbcli/css/auto-complete.css?1634703589" rel="stylesheet">
+    <link href="/rbcli/css/atom-one-dark-reasonable.css?1634703589" rel="stylesheet">
+    <link href="/rbcli/css/theme.css?1634703589" rel="stylesheet">
+    <link href="/rbcli/css/hugo-theme.css?1634703589" rel="stylesheet">
-      <link rel="stylesheet" href="../../assets/stylesheets/application.451f80e5.css">
-      <script src="../../assets/javascripts/modernizr.1aa3b519.js"></script>
+    <link href="/rbcli/css/theme-blue.css?1634703589" rel="stylesheet">
+    <script src="/rbcli/js/jquery-3.3.1.min.js?1634703589"></script>
+    <style>
+      :root #header + #content > #left > #rlblock_left{
+          display:none !important;
+      }
-        <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono">
-        <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
+    </style>
-    <link rel="stylesheet" href="../../assets/fonts/material-icons.css">
+  </head>
+  <body class="" data-url="/rbcli/development/contributing/">
+    <nav id="sidebar" class="">
+  <div id="header-wrapper">
+    <div id="header">
+      <a id="logo" href="https://akhoury6.github.io/rbcli/" style="font-size: 40px">
+  <span class="fas fa-terminal"></span>&nbsp;𝚁𝙱𝙲𝚕𝚒
+</a>
+    </div>
+        <div class="searchbox">
+    <label for="search-by"><i class="fas fa-search"></i></label>
+    <input data-search-input id="search-by" type="search" placeholder="Search...">
+    <span data-search-clear=""><i class="fas fa-times"></i></span>
+</div>
+<script type="text/javascript" src="/rbcli/js/lunr.min.js?1634703589"></script>
+<script type="text/javascript" src="/rbcli/js/auto-complete.js?1634703589"></script>
+<script type="text/javascript">
-  </head>
-    <body dir="ltr">
-    <svg class="md-svg">
-      <defs>
-          <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448"
-    viewBox="0 0 416 448" id="__github">
-  <path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125
-        8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5
-        18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75
-        19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19
-        18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360
-        304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25
-        2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8
-        38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0
-        37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25
-        82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75
-        1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75
-        0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25
-        30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5
-        46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34
-        99.5z" />
-</svg>
-      </defs>
-    </svg>
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
-      <a href="../../#contribution-guide" tabindex="1" class="md-skip">
-        Skip to content
-      </a>
+        var baseurl = "https:\/\/akhoury6.github.io\/rbcli\/";
+</script>
+<script type="text/javascript" src="/rbcli/js/search.js?1634703589"></script>
-      <header class="md-header" data-md-component="header">
-  <nav class="md-header-nav md-grid">
-    <div class="md-flex">
-      <div class="md-flex__cell md-flex__cell--shrink">
-        <a href="../.." title="RBCli Documentation" class="md-header-nav__button md-logo">
-            <i class="md-icon">devices</i>
-        </a>
-      </div>
-      <div class="md-flex__cell md-flex__cell--shrink">
-        <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
-      </div>
-      <div class="md-flex__cell md-flex__cell--stretch">
-        <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
-              <span class="md-header-nav__topic">
-                RBCli Documentation
-              </span>
-              <span class="md-header-nav__topic">
-                Contribution Guide
-              </span>
-        </div>
-      </div>
-      <div class="md-flex__cell md-flex__cell--shrink">
-            <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
-<div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
-      <label class="md-icon md-search__icon" for="__search"></label>
-      <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
-        &#xE5CD;
-      </button>
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="result">
-          <div class="md-search-result__meta">
-            Type to start searching
-          </div>
-          <ol class="md-search-result__list"></ol>
-        </div>
-      </div>
-    </div>
   </div>
-</div>
+    <div class="highlightable">
+    <ul class="topics">
+    <li data-nav-id="/rbcli/quick_reference/" title="Quick Reference" class="dd-item
-      </div>
+        ">
+      <a href="/rbcli/quick_reference/">
+          Quick Reference
+      </a>
-        <div class="md-flex__cell md-flex__cell--shrink">
-          <div class="md-header-nav__source">
+    </li>
-  <a href="https://github.com/akhoury6/rbcli/" title="Go to repository" class="md-source" data-md-source="github">
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    <div class="md-source__repository">
-      GitHub
-    </div>
-  </a>
-          </div>
-        </div>
-    </div>
-  </nav>
-</header>
-    <div class="md-container">
+    <li data-nav-id="/rbcli/tutorial/" title="Tutorial" class="dd-item
-<nav class="md-tabs md-tabs--active" data-md-component="tabs">
-  <div class="md-tabs__inner md-grid">
-    <ul class="md-tabs__list">
-  <li class="md-tabs__item">
-      <a href="../.." title="Home" class="md-tabs__link">
-        Home
+        ">
+      <a href="/rbcli/tutorial/">
+          Tutorial
       </a>
-  </li>
+        <ul>
-    <li class="md-tabs__item">
-        <a href="../../tutorial/10-getting_started/" title="Tutorial" class="md-tabs__link">
-          Tutorial
+      <li data-nav-id="/rbcli/tutorial/10-getting_started/" title="Getting Started" class="dd-item ">
+        <a href="/rbcli/tutorial/10-getting_started/">
+        <b>1. </b>Getting Started
         </a>
     </li>
-    <li class="md-tabs__item">
-        <a href="../../advanced/command_types/" title="Advanced Features" class="md-tabs__link">
-          Advanced Features
+      <li data-nav-id="/rbcli/tutorial/20-project_layout/" title="The Project Layout" class="dd-item ">
+        <a href="/rbcli/tutorial/20-project_layout/">
+        <b>2. </b>The Project Layout
         </a>
     </li>
-    <li class="md-tabs__item">
-        <a href="./" title="Development" class="md-tabs__link md-tabs__link--active">
-          Development
+      <li data-nav-id="/rbcli/tutorial/30-your_first_command/" title="Your First Command" class="dd-item ">
+        <a href="/rbcli/tutorial/30-your_first_command/">
+        <b>3. </b>Your First Command
         </a>
     </li>
-    </ul>
-  </div>
-</nav>
-      <main class="md-main">
-        <div class="md-main__inner md-grid" data-md-component="container">
-              <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    <nav class="md-nav md-nav--primary" data-md-level="0">
-  <label class="md-nav__title md-nav__title--site" for="__drawer">
-    <a href="../.." title="RBCli Documentation" class="md-nav__button md-logo">
-        <i class="md-icon">devices</i>
-    </a>
-    RBCli Documentation
-  </label>
-    <div class="md-nav__source">
-  <a href="https://github.com/akhoury6/rbcli/" title="Go to repository" class="md-source" data-md-source="github">
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    <div class="md-source__repository">
-      GitHub
-    </div>
-  </a>
-    </div>
-  <ul class="md-nav__list" data-md-scrollfix>
+      <li data-nav-id="/rbcli/tutorial/40-options_parameters_and_arguments/" title="Options, Parameters, and Arguments" class="dd-item ">
+        <a href="/rbcli/tutorial/40-options_parameters_and_arguments/">
+        <b>4. </b>Options, Parameters, and Arguments
+        </a>
+    </li>
-  <li class="md-nav__item">
-    <a href="../.." title="Home" class="md-nav__link">
-      Home
-    </a>
-  </li>
+      <li data-nav-id="/rbcli/tutorial/50-publishing/" title="Publishing Your Application" class="dd-item ">
+        <a href="/rbcli/tutorial/50-publishing/">
+        <b>5. </b>Publishing Your Application
+        </a>
+    </li>
+        </ul>
+    </li>
-  <li class="md-nav__item">
-    <a href="../../imported/quick_reference/" title="Quick Reference" class="md-nav__link">
-      Quick Reference
-    </a>
-  </li>
-  <li class="md-nav__item md-nav__item--nested">
-      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
-    <label class="md-nav__link" for="nav-3">
-      Tutorial
-    </label>
-    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
-      <label class="md-nav__title" for="nav-3">
-        Tutorial
-      </label>
-      <ul class="md-nav__list" data-md-scrollfix>
+    <li data-nav-id="/rbcli/advanced/" title="Advanced" class="dd-item
+        ">
+      <a href="/rbcli/advanced/">
+          Advanced
+      </a>
+        <ul>
-  <li class="md-nav__item">
-    <a href="../../tutorial/10-getting_started/" title="Getting Started" class="md-nav__link">
-      Getting Started
-    </a>
-  </li>
-  <li class="md-nav__item">
-    <a href="../../tutorial/20-project_layout/" title="The Project Layout" class="md-nav__link">
-      The Project Layout
-    </a>
-  </li>
+      <li data-nav-id="/rbcli/advanced/automatic_updates/" title="Automatic Updates" class="dd-item ">
+        <a href="/rbcli/advanced/automatic_updates/">
+        Automatic Updates
+        </a>
+    </li>
-  <li class="md-nav__item">
-    <a href="../../tutorial/30-your_first_command/" title="Your First Command" class="md-nav__link">
-      Your First Command
-    </a>
-  </li>
+      <li data-nav-id="/rbcli/advanced/command_types/" title="Command Types" class="dd-item ">
+        <a href="/rbcli/advanced/command_types/">
+        Command Types
+        </a>
+    </li>
-  <li class="md-nav__item">
-    <a href="../../tutorial/40-options_parameters_and_arguments/" title="Options, Parameters, and Arguments" class="md-nav__link">
-      Options, Parameters, and Arguments
-    </a>
-  </li>
+      <li data-nav-id="/rbcli/advanced/distributed_state_locking/" title="Distributed State and Locking" class="dd-item ">
+        <a href="/rbcli/advanced/distributed_state_locking/">
+        Distributed State and Locking
+        </a>
+    </li>
-  <li class="md-nav__item">
-    <a href="../../tutorial/50-publishing/" title="Publishing and Distribution" class="md-nav__link">
-      Publishing and Distribution
-    </a>
-  </li>
-      </ul>
-    </nav>
-  </li>
-  <li class="md-nav__item md-nav__item--nested">
-      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
-    <label class="md-nav__link" for="nav-4">
-      Advanced Features
-    </label>
-    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
-      <label class="md-nav__title" for="nav-4">
-        Advanced Features
-      </label>
-      <ul class="md-nav__list" data-md-scrollfix>
+      <li data-nav-id="/rbcli/advanced/hooks/" title="Execution Hooks" class="dd-item ">
+        <a href="/rbcli/advanced/hooks/">
+        Execution Hooks
+        </a>
+    </li>
-  <li class="md-nav__item">
-    <a href="../../advanced/command_types/" title="Command Types" class="md-nav__link">
-      Command Types
-    </a>
-  </li>
+      <li data-nav-id="/rbcli/advanced/interactive_commands/" title="Interactive Commands" class="dd-item ">
+        <a href="/rbcli/advanced/interactive_commands/">
+        Interactive Commands
+        </a>
+    </li>
-  <li class="md-nav__item">
-    <a href="../../advanced/user_config_files/" title="User Config Files" class="md-nav__link">
-      User Config Files
-    </a>
-  </li>
+      <li data-nav-id="/rbcli/advanced/logging/" title="Logging" class="dd-item ">
+        <a href="/rbcli/advanced/logging/">
+        Logging
+        </a>
+    </li>
-  <li class="md-nav__item">
-    <a href="../../advanced/hooks/" title="Hooks" class="md-nav__link">
-      Hooks
-    </a>
-  </li>
+      <li data-nav-id="/rbcli/advanced/remote_execution/" title="Remote Execution" class="dd-item ">
+        <a href="/rbcli/advanced/remote_execution/">
+        Remote Execution
+        </a>
+    </li>
-  <li class="md-nav__item">
-    <a href="../../advanced/logging/" title="Logging" class="md-nav__link">
-      Logging
-    </a>
-  </li>
+      <li data-nav-id="/rbcli/advanced/state_storage/" title="State Storage" class="dd-item ">
+        <a href="/rbcli/advanced/state_storage/">
+        State Storage
+        </a>
+    </li>
-  <li class="md-nav__item">
-    <a href="../../advanced/automatic_updates/" title="Automatic Updates" class="md-nav__link">
-      Automatic Updates
-    </a>
-  </li>
+      <li data-nav-id="/rbcli/advanced/user_config_files/" title="User Configuration Files" class="dd-item ">
+        <a href="/rbcli/advanced/user_config_files/">
+        User Configuration Files
+        </a>
+    </li>
+        </ul>
+    </li>
-  <li class="md-nav__item">
-    <a href="../../advanced/state_storage/" title="State Storage" class="md-nav__link">
-      State Storage
-    </a>
-  </li>
+    <li data-nav-id="/rbcli/development/" title="Development" class="dd-item
+        parent
+        ">
+      <a href="/rbcli/development/">
+          Development
+      </a>
+        <ul>
-  <li class="md-nav__item">
-    <a href="../../advanced/distributed_state_locking/" title="Distributed State Locking" class="md-nav__link">
-      Distributed State Locking
-    </a>
-  </li>
-  <li class="md-nav__item">
-    <a href="../../advanced/remote_execution/" title="Remote Execution" class="md-nav__link">
-      Remote Execution
-    </a>
-  </li>
+      <li data-nav-id="/rbcli/development/contributing/" title="Contribution Guide" class="dd-item active">
+        <a href="/rbcli/development/contributing/">
+        Contribution Guide
+        </a>
+    </li>
-  <li class="md-nav__item">
-    <a href="../../advanced/interactive_commands/" title="Interactive Commands" class="md-nav__link">
-      Interactive Commands
-    </a>
-  </li>
-      </ul>
-    </nav>
-  </li>
+      <li data-nav-id="/rbcli/development/license/" title="License Info" class="dd-item ">
+        <a href="/rbcli/development/license/">
+        License Info
+        </a>
+    </li>
-  <li class="md-nav__item md-nav__item--active md-nav__item--nested">
-      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5" checked>
-    <label class="md-nav__link" for="nav-5">
-      Development
-    </label>
-    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
-      <label class="md-nav__title" for="nav-5">
-        Development
-      </label>
-      <ul class="md-nav__list" data-md-scrollfix>
+      <li data-nav-id="/rbcli/development/code_of_conduct/" title="Code of Conduct" class="dd-item ">
+        <a href="/rbcli/development/code_of_conduct/">
+        Code of Conduct
+        </a>
+    </li>
-  <li class="md-nav__item md-nav__item--active">
-    <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
-    <a href="./" title="Contribution Guide" class="md-nav__link md-nav__link--active">
-      Contribution Guide
-    </a>
-  </li>
+      <li data-nav-id="/rbcli/development/changelog/" title="Changelog" class="dd-item ">
+        <a href="/rbcli/development/changelog/">
+        Changelog
+        </a>
+    </li>
+        </ul>
+    </li>
-  <li class="md-nav__item">
-    <a href="../license/" title="License Info" class="md-nav__link">
-      License Info
-    </a>
-  </li>
+    <li data-nav-id="/rbcli/whoami/" title="My Letter To You" class="dd-item
+        ">
+      <a href="/rbcli/whoami/">
+          My Letter To You
+      </a>
+    </li>
-  <li class="md-nav__item">
-    <a href="../code_of_conduct/" title="Code of Conduct" class="md-nav__link">
-      Code of Conduct
-    </a>
-  </li>
+    </ul>
+      <section id="shortcuts">
+        <h3>More</h3>
+        <ul>
+              <li>
+                  <a class="padding" href="https://github.com/akhoury6/rbcli"><i class='fab fa-github'></i> Github repo</a>
+              </li>
+              <li>
+                  <a class="padding" href="https://rubygems.org/gems/rbcli"><i class='far fa-gem'></i> Rubygems</a>
+              </li>
+        </ul>
+      </section>
+    <section id="footer">
+      <p>Built with <a href="https://github.com/matcornic/hugo-theme-learn"><i class="fas fa-heart"></i></a> from <a href="https://getgrav.org">Grav</a> and <a href="https://gohugo.io/">Hugo</a></p>
-  <li class="md-nav__item">
-    <a href="../../imported/changelog/" title="Changelog" class="md-nav__link">
-      Changelog
-    </a>
-  </li>
-      </ul>
-    </nav>
-  </li>
+    </section>
+  </div>
+</nav>
-  <li class="md-nav__item">
-    <a href="../../whoami/" title="whoami" class="md-nav__link">
-      whoami
-    </a>
-  </li>
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
+        <section id="body">
+        <div id="overlay"></div>
+        <div class="padding highlightable">
+              <div>
+                <div id="top-bar">
+                <div id="breadcrumbs" itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb">
+                    <span id="sidebar-toggle-span">
+                        <a href="#" id="sidebar-toggle" data-sidebar-toggle="">
+                          <i class="fas fa-bars"></i>
+                        </a>
+                    </span>
+                  <span id="toc-menu"><i class="fas fa-list-alt"></i></span>
+                  <span class="links">
-              <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-<nav class="md-nav md-nav--secondary">
-</nav>
-                  </div>
+            <a href='/rbcli/'></a> > <a href='/rbcli/development/'>Development</a> > Contribution Guide
+                  </span>
                 </div>
+                    <div class="progress">
+    <div class="wrapper">
+<nav id="TableOfContents">
+  <ul>
+    <li><a href="#tabs-not-spaces">Tabs, Not Spaces</a></li>
+    <li><a href="#documentation-for-user-features">Documentation for User Features</a></li>
+    <li><a href="#deprecations">Deprecations</a></li>
+  </ul>
+</nav>
+    </div>
+</div>
               </div>
+            </div>
+        <div id="head-tags">
+        </div>
+        <div id="body-inner">
-          <div class="md-content">
-            <article class="md-content__inner md-typeset">
+            <h1>
-                <h1 id="contribution-guide">Contribution Guide</h1>
+              Contribution Guide
+            </h1>
 <p>Contributing to RBCli is the same as most open source projects:</p>
 <ol>
 <li>Fork the repository</li>
 <li>Create your own branch</li>
 <li>Submit a pull request when ready</li>
 </ol>
-<p>That's all there is to it! We've also kept our acceptance criteria pretty simple, as you'll see below. Feel free to submit a pull request even if you don't meet it if you would like your code or feature to be reviewed first; we do want to be mindful of your time and will review submissions before they are polished.</p>
-<h1 id="code-acceptance-criteria">Code Acceptance Criteria</h1>
+<p>That&rsquo;s all there is to it! We&rsquo;ve also kept our acceptance criteria pretty simple, as you&rsquo;ll see below. Feel free to submit a pull request even if you don&rsquo;t meet it if you would like your code or feature to be reviewed first; we do want to be mindful of your time and will review submissions before they are polished.</p>
+<h1 id="develpment-mode">Develpment Mode</h1>
+<p>To allow for easy deveopment, Rbcli has a development mode which allows a project to include rbcli from a local folder instead of the default gem path. To use it, add the following to your shell&rsquo;s profile (typically <code>~/.bash_profile</code> or <code>~/.profile</code>):</p>
+<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">export RBCLI_ENV<span style="color:#f92672">=</span><span style="color:#e6db74">&#39;development&#39;</span>
+export RBCLI_DEVPATH<span style="color:#f92672">=</span><span style="color:#e6db74">&#39;/path/to/rbcli/lib/rbcli&#39;</span>
+alias rbcli<span style="color:#f92672">=</span><span style="color:#e6db74">&#39;/path/to/rbcli/exe/rbcli&#39;</span>
+</code></pre></div><h1 id="code-acceptance-criteria">Code Acceptance Criteria</h1>
 <h2 id="tabs-not-spaces">Tabs, Not Spaces</h2>
 <p>Please, and thanks. We all like to use different indentation levels and styles, and this will keep us consistent between editors.</p>
 <p>For filetypes where tabs are not supported (such as YAML), please stick to using two (2) spaces.</p>
 <h2 id="documentation-for-user-features">Documentation for User Features</h2>
-<p>For any modification that alters the way RBCli is used -- we're talking additional features, options, keyword changes, major behavioral changes, and the like -- the documentation will need to be updated as well. You'll be happy to know we designed it to make the process relatively painless.</p>
-<p>RBCli's documentation is essentially a collection of markdown files that have been compiled into a static site using <a href="https://www.mkdocs.org">MkDocs</a>. If you already have python and pip on your system, you can install it by running:</p>
-<pre><code class="bash">pip install mkdocs mkdocs-material
-</code></pre>
-<p>You can find the source markdown files in the <code>docs-src/docs</code> folder, and the menu organization in <code>docs-src/mkdocs.yml</code>. To preview your changes on a live site, run:</p>
-<pre><code class="bash">mkdocs serve
-</code></pre>
-<p>Also, don't forget to update the <strong>Quick Reference Guide</strong> in the <code>README.md</code> file (the main project one) with information about your changes.</p>
-<p>Once you've completed your edits, run the <code>makesite.sh</code> command to build the actual HTML pages automatically in the <code>docs</code> folder, from where they will be served when live.</p>
+<p>For any modification that alters the way RBCli is used &ndash; we&rsquo;re talking additional features, options, keyword changes, major behavioral changes, and the like &ndash; the documentation will need to be updated as well. You&rsquo;ll be happy to know we designed it to make the process relatively painless.</p>
+<p>RBCli&rsquo;s documentation is essentially a collection of markdown files that have been compiled into a static site using <a href="https://www.mkdocs.org">MkDocs</a>. If you already have python and pip on your system, you can install it by running:</p>
+<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">pip install mkdocs mkdocs-material
+</code></pre></div><p>You can find the source markdown files in the <code>docs-src/docs</code> folder, and the menu organization in <code>docs-src/mkdocs.yml</code>. To preview your changes on a live site, run:</p>
+<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">mkdocs serve
+</code></pre></div><p>Also, don&rsquo;t forget to update the <strong>Quick Reference Guide</strong> in the <code>README.md</code> file (the main project one) with information about your changes.</p>
+<p>Once you&rsquo;ve completed your edits, run the <code>makesite.sh</code> command to build the actual HTML pages automatically in the <code>docs</code> folder, from where they will be served when live.</p>
 <h2 id="deprecations">Deprecations</h2>
 <p>If a feature needs to be deprecated, RBCli has a built-in deprecation message feature. You can leverage it by calling the following code when a deprecated command is called:</p>
-<pre><code class="ruby">Rbcli::DeprecationWarning.new deprecated_command, message, version_when_code_will_be_removed
-</code></pre>
-<p>So, for example:</p>
-<pre><code class="ruby">Rbcli::DeprecationWarning.new 'Rbcli::Configurate.me--first_run', 'Please use `RBCli::Configurate.hooks` as the parent block instead.', '0.3.0'
-</code></pre>
-<p>will display the following message to the user, in red, any any time the application is run:</p>
-<pre><code class="text">DEPRECATION WRNING: The feature `Rbcli::Configurate.me--post_hook` has been deprecated. Please use `RBCli::Configurate.hooks` as the parent block instead. This feature will be removed in version 0.3.0.
-</code></pre>
-<p>Additionally, it will place the same line in the logs using <code>Rbcli.logger.warn</code> if logging is enabled.</p>
+<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-ruby" data-lang="ruby"><span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">DeprecationWarning</span><span style="color:#f92672">.</span>new deprecated_command, message, version_when_code_will_be_removed
+</code></pre></div><p>So, for example:</p>
+<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-ruby" data-lang="ruby"><span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">DeprecationWarning</span><span style="color:#f92672">.</span>new <span style="color:#e6db74">&#39;Rbcli::Configurate.me--first_run&#39;</span>, <span style="color:#e6db74">&#39;Please use `RBCli::Configurate.hooks` as the parent block instead.&#39;</span>, <span style="color:#e6db74">&#39;0.3.0&#39;</span>
+</code></pre></div><p>will display the following message to the user, in red, any any time the application is run:</p>
+<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-text" data-lang="text">DEPRECATION WRNING: The feature `Rbcli::Configurate.me--post_hook` has been deprecated. Please use `RBCli::Configurate.hooks` as the parent block instead. This feature will be removed in version 0.3.0.
+</code></pre></div><p>Additionally, it will place the same line in the logs using <code>Rbcli.logger.warn</code> if logging is enabled.</p>
 <p>If a deprecation warning has been added, please remember to mention it in the pull request so that others can update it later.</p>
-<h1 id="maintainers-notes">Maintainer's Notes</h1>
+<h1 id="maintainers-notes">Maintainer&rsquo;s Notes</h1>
 <p>To install this gem onto your local machine from source, run <code>bundle exec rake install</code>.</p>
 <p>To release a new version, follow theese steps:</p>
 <ol>
 <li>Update the version number in <code>version.rb</code></li>
 <li>Run <code>bundle exec rake install</code>, which will update <code>gemfile.lock</code> with the correct version and all dependency changes</li>
 <li>Run <code>docs-src/makesite.sh</code>, which re-compiles the documentation and pulls in the changelog and quick reference automatically</li>
-<li>Commit the above changes to master with a commit message of "vX.X.X" (where X.X.X is the version number), but do not push</li>
+<li>Commit the above changes to master with a commit message of &ldquo;vX.X.X&rdquo; (where X.X.X is the version number), but do not push</li>
 <li>Run <code>bundle exec rake release</code>, which will create a git tag for the version, push git commits and tags, and push the <code>.gem</code> file to <a href="https://rubygems.org">rubygems.org</a>.</li>
 </ol>
-            </article>
-          </div>
-        </div>
-      </main>
-<footer class="md-footer">
-    <div class="md-footer-nav">
-      <nav class="md-footer-nav__inner md-grid">
+<footer class="footline">
+</footer>
-          <a href="../../advanced/interactive_commands/" title="Interactive Commands" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
-            <div class="md-flex__cell md-flex__cell--shrink">
-              <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
-            </div>
-            <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
-              <span class="md-flex__ellipsis">
-                <span class="md-footer-nav__direction">
-                  Previous
-                </span>
-                Interactive Commands
-              </span>
-            </div>
-          </a>
+        </div>
+      </div>
+    <div id="navigation">
-          <a href="../license/" title="License Info" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
-            <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
-              <span class="md-flex__ellipsis">
-                <span class="md-footer-nav__direction">
-                  Next
-                </span>
-                License Info
-              </span>
-            </div>
-            <div class="md-flex__cell md-flex__cell--shrink">
-              <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
-            </div>
-          </a>
-      </nav>
-    </div>
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-footer-copyright">
-          <div class="md-footer-copyright__highlight">
-            Copyright © 2018 Andrew Khoury
-          </div>
-        powered by
-        <a href="https://www.mkdocs.org">MkDocs</a>
-        and
-        <a href="https://squidfunk.github.io/mkdocs-material/">
-          Material for MkDocs</a>
-      </div>
-    </div>
-  </div>
-</footer>
+			<a class="nav nav-prev" href="/rbcli/development/" title="Development"> <i class="fa fa-chevron-left"></i></a>
+			<a class="nav nav-next" href="/rbcli/development/license/" title="License Info" style="margin-right: 0px;"><i class="fa fa-chevron-right"></i></a>
     </div>
+    </section>
-      <script src="../../assets/javascripts/application.583bbe55.js"></script>
-      <script>app.initialize({version:"1.0.3",url:{base:"../.."}})</script>
+    <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
+      <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
+    </div>
+    <script src="/rbcli/js/clipboard.min.js?1634703589"></script>
+    <script src="/rbcli/js/perfect-scrollbar.min.js?1634703589"></script>
+    <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1634703589"></script>
+    <script src="/rbcli/js/jquery.sticky.js?1634703589"></script>
+    <script src="/rbcli/js/featherlight.min.js?1634703589"></script>
+    <script src="/rbcli/js/highlight.pack.js?1634703589"></script>
+    <script>hljs.initHighlightingOnLoad();</script>
+    <script src="/rbcli/js/modernizr.custom-3.6.0.js?1634703589"></script>
+    <script src="/rbcli/js/learn.js?1634703589"></script>
+    <script src="/rbcli/js/hugo-learn.js?1634703589"></script>
+    <link href="/rbcli/mermaid/mermaid.css?1634703589" rel="stylesheet" />
+    <script src="/rbcli/mermaid/mermaid.js?1634703589"></script>
+    <script>
+        mermaid.initialize({ startOnLoad: true });
+    </script>
   </body>
-</html>
+</html>