standup_md 0.3.1 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea914496579afb896f1251193f0d9787c172bb38fc2d4e7954954a07a3acde03
-  data.tar.gz: f2b5239e1e8445a782f56521c1e484d5acf4bb5570c960b6c8d1cfb81d84c36b
+  metadata.gz: 3778ef26e402b37d24ff4b3e7465123ffb3eb0cca19125d5bf44f21b36b92fe7
+  data.tar.gz: 4bef958d825346fdbfdb45c961633245f9edc172ac5877db1723d9c3501f04d5
 SHA512:
-  metadata.gz: 6dccea1152f691f7d4a05a41a2a0eb84871e4e516e55d278e8cb8a4800c1cbeb675126bb70149ee45b5f277678cefa66b5b6567dd0e0f1187fde194db132ac25
-  data.tar.gz: df6d4257bad9e773292483cb5a8d31beabc3eb79ad3d0242b7d96720a81fb6bd926171cde460a0babc64fc735ddd2b79a89192a8bd995f8953562ecfffb46aa7
+  metadata.gz: 262cee1fd957f46c19e39af445d50b89d034c925fc857a0b3e64a042e652ce7c0ebfd1addda1999cf40a8052f05b5b24ed274d443764769bd47d23e2aafea1bb
+  data.tar.gz: bfb62a584c6f9386e821deeade2bbf842999d8a210e225114d137701b2bd603f3934a4416a32cfd21ebf35ad5ada526a75e80dd13c2376d010b72119ce9c3960

data/Gemfile.lock

@@ -1,23 +1,25 @@
 PATH
   remote: .
   specs:
-    standup_md (0.3.0)
+    standup_md (0.3.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    docile (1.3.2)
-    power_assert (1.2.0)
-    rake (13.0.1)
-    simplecov (0.18.5)
+    docile (1.3.5)
+    power_assert (2.0.0)
+    rake (13.0.3)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
-    test-unit (3.3.5)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    test-unit (3.4.1)
       power_assert
 
 PLATFORMS
-  ruby
+  x86_64-darwin-20
 
 DEPENDENCIES
   rake (~> 13.0, >= 13.0.1)
@@ -26,4 +28,4 @@ DEPENDENCIES
   test-unit (~> 3.3, >= 3.3.5)
 
 BUNDLED WITH
-   2.1.4
+   2.2.16

data/README.md

@@ -1,4 +1,5 @@
 # The Standup Doctor
+<!-- vi: set ts=4 sw=4 : -->
 [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fevanthegrayt%2Fstandup_md%2Fbadge%3Fref%3Dmaster&style=flat)](https://actions-badge.atrox.dev/evanthegrayt/standup_md/goto?ref=master)
 [![Gem Version](https://badge.fury.io/rb/standup_md.svg)](https://badge.fury.io/rb/standup_md)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
@@ -12,26 +13,6 @@ View on: [Github](https://github.com/evanthegrayt/standup_md) |
 [GitHub Pages](https://evanthegrayt.github.io/standup_md/) |
 [RubyGems](https://rubygems.org/gems/standup_md)
 
-## Table of Contents
-- [About](#about)
-- [Installation](#Installation)
-  - [Via RubyGems](#via-rubygems)
-  - [Manual Installation](#manual-installation)
-- [Usage](#usage)
-  - [Command Line](#command-line)
-    - [CLI Examples](#cli-examples)
-      - [Adding an entry for today via editor](#adding-an-entry-for-today-via-editor)
-      - [Copy the entry for today to clipboard](#copy-the-entry-for-today-to-clipboard)
-      - [Add entry to file without opening it](#add-entry-to-file-without-opening-it)
-      - [Find an entry by date and print it](#find-an-entry-by-date-and-print-it)
-    - [Customization and Runtime Options](#customization-and-runtime-options)
-    - [Using existing standup files](#using-existing-standup-files)
-  - [API](#api)
-    - [API Examples](#api-examples)
-    - [Documentation](https://evanthegrayt.github.io/standup_md/doc/index.html)
-- [Reporting Bugs and Requesting Features](#reporting-bugs-and-requesting-features)
-- [Self-Promotion](#self-promotion)
-
 ## About
 I've now been at two separate companies where we post our daily standups in a
 chat client, such as Slack, Mattermost, or Riot. Typing out my standup every day
@@ -45,10 +26,15 @@ for the current month in your preferred editor. If an entry for today is already
 present, no text will be generated. If an entry for today doesn't exist, one
 will be generated with your preferred values. When generating, if a previous
 entry exists, it will be added to today's entry as your previous day's work. See
-[example](#example). There's also a very robust API if you'd like to use this
-in your own code somehow.
+[example](#cli-examples). There's also a very robust API if you'd like to use
+this in your own code somehow.
 
 ## Installation
+If you don't have the permissions to install system-wide gems, you're probabaly
+also running an older version of ruby. I recommend installing
+[rbenv](https://github.com/rbenv/rbenv#installation), and then installing an
+up-to-date version of ruby.
+
 ### Via RubyGems
 Just install the gem!
 
@@ -76,7 +62,7 @@ rake install
 
 ## Usage
 ### Command Line
-For the most basic usage, simplyt call the executable.
+For the most basic usage, simply call the executable.
 
 ```sh
 standup
@@ -132,7 +118,7 @@ result to the command line, you could use the following.
 
 #### Add entry to file without opening it
 ```sh
-standup --no-edit --current "Work on this thing","And another thing" -p
+standup --no-edit --current "Work on this thing","And another thing"
 ```
 
 #### Find an entry by date and print it.
@@ -167,6 +153,8 @@ them again.
 
 
 #### Available Config File Options and Defaults
+For command-line usage, this file needs to be named `~/.standuprc`. To use in a
+rails project, create an initializer (`config/initializers/standup_md.rb`).
 
 ```ruby
 StandupMD.configure do |c|
@@ -205,7 +193,15 @@ StandupMD.configure do |c|
 end
 ```
 
+Any options not set in this file will retain their default values. Note that if
+you change `file_name_format`, and don't use a month or year, there will only
+ever be one standup file. This could cause issues long-term, as the files will
+get large over time and possibly cause performance issues.
+
+
 #### Executable Flags
+Some of these options can be changed at runtime. They are as follows.
+
 ```
     --current ARRAY            List of current entry's tasks
     --previous ARRAY           List of precious entry's tasks
@@ -224,11 +220,6 @@ end
                                DATE must be in the same format as file-name-format
 ```
 
-Any options not set in this file will retain their default values. Note that if
-you change `file_name_format`, and don't use a month or year, there will only
-ever be one standup file. This could cause issues long-term, as the files will
-get large over time and possibly cause performance issues.
-
 #### Using Existing Standup Files
 If you already have a directory of existing standup files, you can use them, but
 they must be in a format that the parser can understand. The default is:
@@ -267,30 +258,29 @@ Your `~/.standuprc` should contain:
 
 ```ruby
 StandupMD.configure do |c|
-  c.file.header_depth        2
-  c.file.sub_header_depth    3
-  c.file.current_header      Today
-  c.file.previous_header     Yesterday
-  c.file.impediments_header  Hold-ups
-  c.file.bullet_character    '*'
-  c.file.header_date_format  '%m/%d/%Y'
-  c.file.sub_header_order = %w[current previous impediments notes]
+  c.file.header_depth       = 2
+  c.file.sub_header_depth   = 3
+  c.file.current_header     = 'Today'
+  c.file.previous_header    = 'Yesterday'
+  c.file.impediments_header = 'Hold-ups'
+  c.file.bullet_character   = '*'
+  c.file.header_date_format = '%m/%d/%Y'
+  c.file.sub_header_order   = %w[current previous impediments notes]
 end
 ```
 
 ## API
 The API is fully documented in the
-[documentation](https://evanthegrayt.github.io/standup_md/doc/index.html).
+[RDoc Documentation](https://evanthegrayt.github.io/standup_md/doc/index.html).
 
 This was mainly written as a command line utility, but the API is ridiculously
 robust, and is available for use in your own projects. A quick example of how
 to write a new entry via code could look like the following:
 
 ### API Examples
-
+#### Adding an entry for today
 ```ruby
 require 'standup_md'
-require 'date'
 
 StandupMD.configure do |c|
   c.file.current_header = 'Today',
@@ -307,7 +297,6 @@ API fit together. The code can actually be simplified to the following.
 
 ```ruby
 require 'standup_md'
-require 'date'
 
 StandupMD.configure do |c|
   c.file.current_header = 'Today',
@@ -317,10 +306,55 @@ end
 StandupMD::File.find_by_date(Date.today).load.write
 ```
 
+#### Finding a past entry
+```ruby
+require 'standup_md'
+
+date = Date.new(2020, 04, 15)
+file = StandupMD::File.find_by_date(date).load
+entry = file.entries.find(date)
+```
+
+## Vim
+While there's no official support for vim, you can add this to your `vimrc`
+file, or something like `~/.vim/plugin/standup.vim`.
+
+```vim
+if executable('standup')
+  command! -complete=custom,s:StandupCompletion -nargs=? -bang Standup
+        \ call s:OpenStandupFile(<bang>0, <f-args>)
+endif
+
+function! s:StandupCompletion(...) abort
+  let l:dir = get(g:, 'standup_dir', $HOME . '/.cache/standup_md') . '/'
+  if !isdirectory(l:dir) | return '' | endif
+  let l:list = glob(l:dir . '*.md', 0, 1)
+  return join(map(l:list, "substitute(v:val, l:dir, '', '')"), "\n")
+endfunction
+
+function! s:OpenStandupFile(split, ...)
+  let l:dir = get(g:, 'standup_dir', $HOME . '/.cache/standup_md') . '/'
+  let l:file = a:0 ? a:1 : get(g:, 'standup_file', strftime('%Y_%m.md'))
+  call system('standup --no-edit')
+  execute a:split ? 'vsplit' : 'split' l:dir . l:file
+endfunction
+```
+
+This makes the `:Standup` command, which opens the standup file in a split,
+while `:Standup!` opens it in a vertical split. If a file is passed to the
+command, that file will be opened. There's tab completion for this. Lastly,
+it allows for a few variables to be set for customization.
+
+```vim
+g:standup_dir = $HOME . '/.cache/standup_md' " the directory where your file are
+g:standup_file = strftime('%Y_%m.md')        " the file format to use
+```
+
 ## Reporting Bugs and Requesting Features
 If you have an idea or find a bug, please [create an
-issue](https://github.com/evanthegrayt/standup_md/issues/new). Just make sure the topic
-doesn't already exist. Better yet, you can always submit a Pull Request.
+issue](https://github.com/evanthegrayt/standup_md/issues/new). Just make sure
+the topic doesn't already exist. Better yet, you can always submit a Pull
+Request.
 
 ## Self-Promotion
 I do these projects for fun, and I enjoy knowing that they're helpful to people.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'lib/standup_md'
 require 'bundler/gem_tasks'
 require 'rdoc/task'
@@ -16,4 +18,4 @@ RDoc::Task.new do |rdoc|
   rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
 end
 
-task :default => :test
+task default: :test

data/doc/README_md.html

@@ -61,7 +61,6 @@
 
   <ul class="link-list" role="directory">
     <li><a href="#label-The+Standup+Doctor">The Standup Doctor</a>
-    <li><a href="#label-Table+of+Contents">Table of Contents</a>
     <li><a href="#label-About">About</a>
     <li><a href="#label-Installation">Installation</a>
     <li><a href="#label-Via+RubyGems">Via RubyGems</a>
@@ -79,6 +78,9 @@
     <li><a href="#label-Using+Existing+Standup+Files">Using Existing Standup Files</a>
     <li><a href="#label-API">API</a>
     <li><a href="#label-API+Examples">API Examples</a>
+    <li><a href="#label-Adding+an+entry+for+today">Adding an entry for today</a>
+    <li><a href="#label-Finding+a+past+entry">Finding a past entry</a>
+    <li><a href="#label-Vim">Vim</a>
     <li><a href="#label-Reporting+Bugs+and+Requesting+Features">Reporting Bugs and Requesting Features</a>
     <li><a href="#label-Self-Promotion">Self-Promotion</a>
   </ul>
@@ -102,7 +104,7 @@
 <main role="main" aria-label="Page README.md">
 
 <h1 id="label-The+Standup+Doctor">The Standup Doctor<span><a href="#label-The+Standup+Doctor">&para;</a> <a href="#top">&uarr;</a></span></h1>
-
+<!-- vi: set ts=4 sw=4 : -->
 <p><a href="https://actions-badge.atrox.dev/evanthegrayt/standup_md/goto?ref=master"><img src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fevanthegrayt%2Fstandup_md%2Fbadge%3Fref%3Dmaster&style=flat"></a> <a href="https://badge.fury.io/rb/standup_md"><img src="https://badge.fury.io/rb/standup_md.svg"></a> <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg"></a></p>
 
 <blockquote>
@@ -113,55 +115,16 @@
 
 <p>View on: <a href="https://github.com/evanthegrayt/standup_md">Github</a> | <a href="https://evanthegrayt.github.io/standup_md/">GitHub Pages</a> | <a href="https://rubygems.org/gems/standup_md">RubyGems</a></p>
 
-<h2 id="label-Table+of+Contents">Table of Contents<span><a href="#label-Table+of+Contents">&para;</a> <a href="#top">&uarr;</a></span></h2>
-<ul><li>
-<p><a href="#about">About</a></p>
-</li><li>
-<p><a href="#Installation">Installation</a></p>
-</li><li>
-<p><a href="#via-rubygems">Via RubyGems</a></p>
-</li><li>
-<p><a href="#manual-installation">Manual Installation</a></p>
-</li><li>
-<p><a href="#usage">Usage</a></p>
-</li><li>
-<p><a href="#command-line">Command Line</a></p>
-<ul><li>
-<p><a href="#cli-examples">CLI Examples</a></p>
-</li><li>
-<p><a href="#adding-an-entry-for-today-via-editor">Adding an entry for today via editor</a></p>
-</li><li>
-<p><a href="#copy-the-entry-for-today-to-clipboard">Copy the entry for today to clipboard</a></p>
-</li><li>
-<p><a href="#add-entry-to-file-without-opening-it">Add entry to file without opening it</a></p>
-</li><li>
-<p><a href="#find-an-entry-by-date-and-print-it">Find an entry by date and print it</a></p>
-</li><li>
-<p><a href="#customization-and-runtime-options">Customization and Runtime Options</a></p>
-</li><li>
-<p><a href="#using-existing-standup-files">Using existing standup files</a></p>
-</li></ul>
-</li><li>
-<p><a href="#api">API</a></p>
-<ul><li>
-<p><a href="#api-examples">API Examples</a></p>
-</li><li>
-<p><a href="https://evanthegrayt.github.io/standup_md/doc/index.html">Documentation</a></p>
-</li></ul>
-</li><li>
-<p><a href="#reporting-bugs-and-requesting-features">Reporting Bugs and Requesting Features</a></p>
-</li><li>
-<p><a href="#self-promotion">Self-Promotion</a></p>
-</li></ul>
-
 <h2 id="label-About">About<span><a href="#label-About">&para;</a> <a href="#top">&uarr;</a></span></h2>
 
 <p>I&#39;ve now been at two separate companies where we post our daily standups in a chat client, such as Slack, Mattermost, or Riot. Typing out my standup every day became tedious, as I&#39;d have to look up what I did the day before, copy and paste yesterday&#39;s work into a new entry, and add today&#39;s tasks. This gem automates most of this process, along with providing means of opening the file in your editor, and finding and displaying entries from the command line.</p>
 
-<p>In a nutshell, calling <code>standup</code> from the command line will open a standup file for the current month in your preferred editor. If an entry for today is already present, no text will be generated. If an entry for today doesn&#39;t exist, one will be generated with your preferred values. When generating, if a previous entry exists, it will be added to today&#39;s entry as your previous day&#39;s work. See <a href="#example">example</a>. There&#39;s also a very robust API if you&#39;d like to use this in your own code somehow.</p>
+<p>In a nutshell, calling <code>standup</code> from the command line will open a standup file for the current month in your preferred editor. If an entry for today is already present, no text will be generated. If an entry for today doesn&#39;t exist, one will be generated with your preferred values. When generating, if a previous entry exists, it will be added to today&#39;s entry as your previous day&#39;s work. See <a href="#cli-examples">example</a>. There&#39;s also a very robust API if you&#39;d like to use this in your own code somehow.</p>
 
 <h2 id="label-Installation">Installation<span><a href="#label-Installation">&para;</a> <a href="#top">&uarr;</a></span></h2>
 
+<p>If you don&#39;t have the permissions to install system-wide gems, you&#39;re probabaly also running an older version of ruby. I recommend installing <a href="https://github.com/rbenv/rbenv#installation">rbenv</a>, and then installing an up-to-date version of ruby.</p>
+
 <h3 id="label-Via+RubyGems">Via RubyGems<span><a href="#label-Via+RubyGems">&para;</a> <a href="#top">&uarr;</a></span></h3>
 
 <p>Just install the gem!</p>
@@ -188,7 +151,7 @@ rake install</pre>
 
 <h3 id="label-Command+Line">Command Line<span><a href="#label-Command+Line">&para;</a> <a href="#top">&uarr;</a></span></h3>
 
-<p>For the most basic usage, simplyt call the executable.</p>
+<p>For the most basic usage, simply call the executable.</p>
 
 <pre class="ruby"><span class="ruby-identifier">standup</span>
 </pre>
@@ -232,7 +195,7 @@ rake install</pre>
 
 <h4 id="label-Add+entry+to+file+without+opening+it">Add entry to file without opening it<span><a href="#label-Add+entry+to+file+without+opening+it">&para;</a> <a href="#top">&uarr;</a></span></h4>
 
-<pre>standup --no-edit --current &quot;Work on this thing&quot;,&quot;And another thing&quot; -p</pre>
+<pre>standup --no-edit --current &quot;Work on this thing&quot;,&quot;And another thing&quot;</pre>
 
 <h4 id="label-Find+an+entry+by+date+and+print+it.">Find an entry by date and print it.<span><a href="#label-Find+an+entry+by+date+and+print+it.">&para;</a> <a href="#top">&uarr;</a></span></h4>
 
@@ -250,6 +213,8 @@ rake install</pre>
 
 <h4 id="label-Available+Config+File+Options+and+Defaults">Available Config File Options and Defaults<span><a href="#label-Available+Config+File+Options+and+Defaults">&para;</a> <a href="#top">&uarr;</a></span></h4>
 
+<p>For command-line usage, this file needs to be named <code>~/.standuprc</code>. To use in a rails project, create an initializer (<code>config/initializers/standup_md.rb</code>).</p>
+
 <pre class="ruby"><span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">configure</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
   <span class="ruby-comment"># Defaults for how the file is formatted.</span>
   <span class="ruby-comment"># See https://evanthegrayt.github.io/standup_md/doc/StandupMD/Config/Cli.html</span>
@@ -286,8 +251,12 @@ rake install</pre>
 <span class="ruby-keyword">end</span>
 </pre>
 
+<p>Any options not set in this file will retain their default values. Note that if you change <code>file_name_format</code>, and don&#39;t use a month or year, there will only ever be one standup file. This could cause issues long-term, as the files will get large over time and possibly cause performance issues.</p>
+
 <h4 id="label-Executable+Flags">Executable Flags<span><a href="#label-Executable+Flags">&para;</a> <a href="#top">&uarr;</a></span></h4>
 
+<p>Some of these options can be changed at runtime. They are as follows.</p>
+
 <pre>--current ARRAY            List of current entry&#39;s tasks
     --previous ARRAY           List of precious entry&#39;s tasks
     --impediments ARRAY        List of impediments for current entry
@@ -304,8 +273,6 @@ rake install</pre>
                                If DATE is passed, will print entry for DATE, if it exists.
                                DATE must be in the same format as file-name-format</pre>
 
-<p>Any options not set in this file will retain their default values. Note that if you change <code>file_name_format</code>, and don&#39;t use a month or year, there will only ever be one standup file. This could cause issues long-term, as the files will get large over time and possibly cause performance issues.</p>
-
 <h4 id="label-Using+Existing+Standup+Files">Using Existing Standup Files<span><a href="#label-Using+Existing+Standup+Files">&para;</a> <a href="#top">&uarr;</a></span></h4>
 
 <p>If you already have a directory of existing standup files, you can use them, but they must be in a format that the parser can understand. The default is:</p>
@@ -337,27 +304,28 @@ rake install</pre>
 <p>Your <code>~/.standuprc</code> should contain:</p>
 
 <pre class="ruby"><span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">configure</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
-  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">header_depth</span>        <span class="ruby-value">2</span>
-  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_depth</span>    <span class="ruby-value">3</span>
-  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">current_header</span>      <span class="ruby-constant">Today</span>
-  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">previous_header</span>     <span class="ruby-constant">Yesterday</span>
-  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">impediments_header</span>  <span class="ruby-constant">Hold</span><span class="ruby-operator">-</span><span class="ruby-identifier">ups</span>
-  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">bullet_character</span>    <span class="ruby-string">&#39;*&#39;</span>
-  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">header_date_format</span>  <span class="ruby-string">&#39;%m/%d/%Y&#39;</span>
-  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_order</span> = <span class="ruby-node">%w[current previous impediments notes]</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">header_depth</span>       = <span class="ruby-value">2</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_depth</span>   = <span class="ruby-value">3</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">current_header</span>     = <span class="ruby-string">&#39;Today&#39;</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">previous_header</span>    = <span class="ruby-string">&#39;Yesterday&#39;</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">impediments_header</span> = <span class="ruby-string">&#39;Hold-ups&#39;</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">bullet_character</span>   = <span class="ruby-string">&#39;*&#39;</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">header_date_format</span> = <span class="ruby-string">&#39;%m/%d/%Y&#39;</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_order</span>   = <span class="ruby-node">%w[current previous impediments notes]</span>
 <span class="ruby-keyword">end</span>
 </pre>
 
 <h2 id="label-API">API<span><a href="#label-API">&para;</a> <a href="#top">&uarr;</a></span></h2>
 
-<p>The API is fully documented in the <a href="https://evanthegrayt.github.io/standup_md/doc/index.html">documentation</a>.</p>
+<p>The API is fully documented in the <a href="https://evanthegrayt.github.io/standup_md/doc/index.html">RDoc Documentation</a>.</p>
 
 <p>This was mainly written as a command line utility, but the API is ridiculously robust, and is available for use in your own projects. A quick example of how to write a new entry via code could look like the following:</p>
 
 <h3 id="label-API+Examples">API Examples<span><a href="#label-API+Examples">&para;</a> <a href="#top">&uarr;</a></span></h3>
 
+<h4 id="label-Adding+an+entry+for+today">Adding an entry for today<span><a href="#label-Adding+an+entry+for+today">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
 <pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;standup_md&#39;</span>
-<span class="ruby-identifier">require</span> <span class="ruby-string">&#39;date&#39;</span>
 
 <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">configure</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
   <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">current_header</span> = <span class="ruby-string">&#39;Today&#39;</span>,
@@ -372,7 +340,6 @@ rake install</pre>
 <p>The above example was written as such to show how the different pieces of the API fit together. The code can actually be simplified to the following.</p>
 
 <pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;standup_md&#39;</span>
-<span class="ruby-identifier">require</span> <span class="ruby-string">&#39;date&#39;</span>
 
 <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">configure</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
   <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">current_header</span> = <span class="ruby-string">&#39;Today&#39;</span>,
@@ -382,6 +349,43 @@ rake install</pre>
 <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">find_by_date</span>(<span class="ruby-constant">Date</span>.<span class="ruby-identifier">today</span>).<span class="ruby-identifier">load</span>.<span class="ruby-identifier">write</span>
 </pre>
 
+<h4 id="label-Finding+a+past+entry">Finding a past entry<span><a href="#label-Finding+a+past+entry">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;standup_md&#39;</span>
+
+<span class="ruby-identifier">date</span> = <span class="ruby-constant">Date</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">2020</span>, <span class="ruby-value">04</span>, <span class="ruby-value">15</span>)
+<span class="ruby-identifier">file</span> = <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">find_by_date</span>(<span class="ruby-identifier">date</span>).<span class="ruby-identifier">load</span>
+<span class="ruby-identifier">entry</span> = <span class="ruby-identifier">file</span>.<span class="ruby-identifier">entries</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">date</span>)
+</pre>
+
+<h2 id="label-Vim">Vim<span><a href="#label-Vim">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<p>While there&#39;s no official support for vim, you can add this to your <code>vimrc</code> file, or something like <code>~/.vim/plugin/standup.vim</code>.</p>
+
+<pre>if executable(&#39;standup&#39;)
+  command! -complete=custom,s:StandupCompletion -nargs=? -bang Standup
+        \ call s:OpenStandupFile(&lt;bang&gt;0, &lt;f-args&gt;)
+endif
+
+function! s:StandupCompletion(...) abort
+  let l:dir = get(g:, &#39;standup_dir&#39;, $HOME . &#39;/.cache/standup_md&#39;) . &#39;/&#39;
+  if !isdirectory(l:dir) | return &#39;&#39; | endif
+  let l:list = glob(l:dir . &#39;*.md&#39;, 0, 1)
+  return join(map(l:list, &quot;substitute(v:val, l:dir, &#39;&#39;, &#39;&#39;)&quot;), &quot;\n&quot;)
+endfunction
+
+function! s:OpenStandupFile(split, ...)
+  let l:dir = get(g:, &#39;standup_dir&#39;, $HOME . &#39;/.cache/standup_md&#39;) . &#39;/&#39;
+  let l:file = a:0 ? a:1 : get(g:, &#39;standup_file&#39;, strftime(&#39;%Y_%m.md&#39;))
+  call system(&#39;standup --no-edit&#39;)
+  execute a:split ? &#39;vsplit&#39; : &#39;split&#39; l:dir . l:file
+endfunction</pre>
+
+<p>This makes the <code>:Standup</code> command, which opens the standup file in a split, while <code>:Standup!</code> opens it in a vertical split. If a file is passed to the command, that file will be opened. There&#39;s tab completion for this. Lastly, it allows for a few variables to be set for customization.</p>
+
+<pre>g:standup_dir = $HOME . &#39;/.cache/standup_md&#39; &quot; the directory where your file are
+g:standup_file = strftime(&#39;%Y_%m.md&#39;)        &quot; the file format to use</pre>
+
 <h2 id="label-Reporting+Bugs+and+Requesting+Features">Reporting Bugs and Requesting Features<span><a href="#label-Reporting+Bugs+and+Requesting+Features">&para;</a> <a href="#top">&uarr;</a></span></h2>
 
 <p>If you have an idea or find a bug, please <a href="https://github.com/evanthegrayt/standup_md/issues/new">create an issue</a>. Just make sure the topic doesn&#39;t already exist. Better yet, you can always submit a Pull Request.</p>