on CRAN installation instructions

devOpifex · Jan 14, 2021 · 3180c06 · 3180c06
1 parent d7643d6
commit 3180c06
Show file tree

Hide file tree

Showing 19 changed files with 878 additions and 159 deletions.
diff --git a/CRAN-RELEASE b/CRAN-RELEASE
diff --git a/docs/index.md b/docs/index.md
@@ -4,36 +4,17 @@
 
 A convenient logger for R, shiny, and plumber.
 
-[Get Started](/guide/get-started){: .md-button }
+[Get Started](/guide/get-started){: .md-button .md-button--primary }
+[Install](/installation){: .md-button }
 
-## Installation
-
-Titan is not yet available on CRAN, it can be obtained from [Github](https://github.com/devOpifex/titan) in a variety of ways.
-
-### remotes
-
-You can use the `remotes` package.
-
-```r
-# install.packages("remotes")
-remotes::install_github("devOpifex/titan")
-```
-
-### pak
-
-You can use the `pak` package.
+## Example
 
 ```r
-# install.packages("pak")
-pak::pkg_install("devOpifex/titan")
-```
+log <- Logger$new(prefix = "INFO")
 
-### devtools
+log$log("Something")
+#> INFO       Something 
 
-You can use the `devtools` package.
-
-```r
-# install.packages("devtools")
-devtools::install_github("devOpifex/titan")
+log$log("Something else")
+#> INFO       Something else
 ```
-
diff --git a/docs/installation.md b/docs/installation.md
@@ -0,0 +1,43 @@
+# Installation
+
+Install the stable version for production, or install the dev version if you want the latest features but it may be somewhat unstable.
+
+## Stable
+
+The stable version is available from CRAN.
+
+```r
+install.packages("log")
+```
+
+## Dev
+
+The dev version can be obtained from [Github](https://github.com/devOpifex/log) in a variety of ways.
+
+### remotes
+
+You can use the `remotes` package.
+
+```r
+# install.packages("remotes")
+remotes::install_github("devOpifex/titan")
+```
+
+### pak
+
+You can use the `pak` package.
+
+```r
+# install.packages("pak")
+pak::pkg_install("devOpifex/titan")
+```
+
+### devtools
+
+You can use the `devtools` package.
+
+```r
+# install.packages("devtools")
+devtools::install_github("devOpifex/titan")
+```
+
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -40,6 +40,7 @@ markdown_extensions:
 
 nav:
   - Home: index.md
+  - Installation: installation.md
   - Guide:
     - Get Started: guide/get-started.md
     - Templates: guide/templates.md

diff --git a/site/404.html b/site/404.html
@@ -203,15 +203,27 @@
 
 
 
+  <li class="md-nav__item">
+    <a href="/installation/" class="md-nav__link">
+      Installation
+    </a>
+  </li>
+
+
+
+
+
+
+
   <li class="md-nav__item md-nav__item--nested">
 
-    <input class="md-nav__toggle md-toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2" >
-    <label class="md-nav__link" for="nav-2">
+    <input class="md-nav__toggle md-toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" >
+    <label class="md-nav__link" for="nav-3">
       Guide
       <span class="md-nav__icon md-icon"></span>
     </label>
     <nav class="md-nav" aria-label="Guide" data-md-level="1">
-      <label class="md-nav__title" for="nav-2">
+      <label class="md-nav__title" for="nav-3">
         <span class="md-nav__icon md-icon"></span>
         Guide
       </label>

diff --git a/site/guide/ambiorix/index.html b/site/guide/ambiorix/index.html
@@ -207,18 +207,30 @@
 
 
 
+
+  <li class="md-nav__item">
+    <a href="../../installation/" class="md-nav__link">
+      Installation
+    </a>
+  </li>
+
+
+
+
+
+
 
 
 
   <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 
-    <input class="md-nav__toggle md-toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2" checked>
-    <label class="md-nav__link" for="nav-2">
+    <input class="md-nav__toggle md-toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" checked>
+    <label class="md-nav__link" for="nav-3">
       Guide
       <span class="md-nav__icon md-icon"></span>
     </label>
     <nav class="md-nav" aria-label="Guide" data-md-level="1">
-      <label class="md-nav__title" for="nav-2">
+      <label class="md-nav__title" for="nav-3">
         <span class="md-nav__icon md-icon"></span>
         Guide
       </label>

diff --git a/site/guide/erratum/index.html b/site/guide/erratum/index.html
@@ -207,18 +207,30 @@
 
 
 
+
+  <li class="md-nav__item">
+    <a href="../../installation/" class="md-nav__link">
+      Installation
+    </a>
+  </li>
+
+
+
+
+
+
 
 
 
   <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 
-    <input class="md-nav__toggle md-toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2" checked>
-    <label class="md-nav__link" for="nav-2">
+    <input class="md-nav__toggle md-toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" checked>
+    <label class="md-nav__link" for="nav-3">
       Guide
       <span class="md-nav__icon md-icon"></span>
     </label>
     <nav class="md-nav" aria-label="Guide" data-md-level="1">
-      <label class="md-nav__title" for="nav-2">
+      <label class="md-nav__title" for="nav-3">
         <span class="md-nav__icon md-icon"></span>
         Guide
       </label>

diff --git a/site/guide/get-started/index.html b/site/guide/get-started/index.html
@@ -207,18 +207,30 @@
 
 
 
+
+  <li class="md-nav__item">
+    <a href="../../installation/" class="md-nav__link">
+      Installation
+    </a>
+  </li>
+
+
+
+
+
+
 
 
 
   <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 
-    <input class="md-nav__toggle md-toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2" checked>
-    <label class="md-nav__link" for="nav-2">
+    <input class="md-nav__toggle md-toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" checked>
+    <label class="md-nav__link" for="nav-3">
       Guide
       <span class="md-nav__icon md-icon"></span>
     </label>
     <nav class="md-nav" aria-label="Guide" data-md-level="1">
-      <label class="md-nav__title" for="nav-2">
+      <label class="md-nav__title" for="nav-3">
         <span class="md-nav__icon md-icon"></span>
         Guide
       </label>
@@ -744,7 +756,7 @@ <h2 id="predicate">Predicate<a class="headerlink" href="#predicate" title="Perma
     <div class="md-footer-nav">
       <nav class="md-footer-nav__inner md-grid" aria-label="Footer">
 
-          <a href="../.." class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
+          <a href="../../installation/" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
             <div class="md-footer-nav__button md-icon">
               <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
             </div>
@@ -753,7 +765,7 @@ <h2 id="predicate">Predicate<a class="headerlink" href="#predicate" title="Perma
                 <span class="md-footer-nav__direction">
                   Previous
                 </span>
-                Home
+                Installation
               </div>
             </div>
           </a>

diff --git a/site/guide/plumber/index.html b/site/guide/plumber/index.html
@@ -207,18 +207,30 @@
 
 
 
+
+  <li class="md-nav__item">
+    <a href="../../installation/" class="md-nav__link">
+      Installation
+    </a>
+  </li>
+
+
+
+
+
+
 
 
 
   <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 
-    <input class="md-nav__toggle md-toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2" checked>
-    <label class="md-nav__link" for="nav-2">
+    <input class="md-nav__toggle md-toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" checked>
+    <label class="md-nav__link" for="nav-3">
       Guide
       <span class="md-nav__icon md-icon"></span>
     </label>
     <nav class="md-nav" aria-label="Guide" data-md-level="1">
-      <label class="md-nav__title" for="nav-2">
+      <label class="md-nav__title" for="nav-3">
         <span class="md-nav__icon md-icon"></span>
         Guide
       </label>

diff --git a/site/guide/shiny/index.html b/site/guide/shiny/index.html
@@ -207,18 +207,30 @@
 
 
 
+
+  <li class="md-nav__item">
+    <a href="../../installation/" class="md-nav__link">
+      Installation
+    </a>
+  </li>
+
+
+
+
+
+
 
 
 
   <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 
-    <input class="md-nav__toggle md-toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2" checked>
-    <label class="md-nav__link" for="nav-2">
+    <input class="md-nav__toggle md-toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" checked>
+    <label class="md-nav__link" for="nav-3">
       Guide
       <span class="md-nav__icon md-icon"></span>
     </label>
     <nav class="md-nav" aria-label="Guide" data-md-level="1">
-      <label class="md-nav__title" for="nav-2">
+      <label class="md-nav__title" for="nav-3">
         <span class="md-nav__icon md-icon"></span>
         Guide
       </label>

diff --git a/site/guide/templates/index.html b/site/guide/templates/index.html
@@ -207,18 +207,30 @@
 
 
 
+
+  <li class="md-nav__item">
+    <a href="../../installation/" class="md-nav__link">
+      Installation
+    </a>
+  </li>
+
+
+
+
+
+
 
 
 
   <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 
-    <input class="md-nav__toggle md-toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2" checked>
-    <label class="md-nav__link" for="nav-2">
+    <input class="md-nav__toggle md-toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" checked>
+    <label class="md-nav__link" for="nav-3">
       Guide
       <span class="md-nav__icon md-icon"></span>
     </label>
     <nav class="md-nav" aria-label="Guide" data-md-level="1">
-      <label class="md-nav__title" for="nav-2">
+      <label class="md-nav__title" for="nav-3">
         <span class="md-nav__icon md-icon"></span>
         Guide
       </label>
@@ -406,7 +418,7 @@ <h1 id="templates">Templates<a class="headerlink" href="#templates" title="Perma
 17</pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="n">foo</span> <span class="o">&lt;-</span> <span class="nf">function</span><span class="p">(){</span>
   <span class="n">info</span> <span class="o">&lt;-</span> <span class="nf">infoLog</span><span class="p">()</span>
   <span class="n">error</span> <span class="o">&lt;-</span> <span class="nf">errorLog</span><span class="p">()</span>
-  <span class="n">warn</span> <span class="o">&lt;-</span> <span class="nf">warnLog</span><span class="p">()</span>
+  <span class="n">warn</span> <span class="o">&lt;-</span> <span class="nf">warningLog</span><span class="p">()</span>
   <span class="n">success</span> <span class="o">&lt;-</span> <span class="nf">successLog</span><span class="p">()</span>
 
   <span class="n">info</span><span class="o">$</span><span class="nf">log</span><span class="p">(</span><span class="s">&quot;Some information&quot;</span><span class="p">)</span>