Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
evanthegrayt committed Apr 13, 2021
1 parent e53c72d commit 22b836a
Show file tree
Hide file tree
Showing 6 changed files with 3 additions and 131 deletions.
23 changes: 0 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,29 +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)
- [Adding an entry for today](#adding-an-entry-for-today)
- [Finding a past entry](#finding-a-past-entry)
- [Documentation](https://evanthegrayt.github.io/standup_md/doc/index.html)
- [Vim](#vim)
- [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
Expand Down
52 changes: 0 additions & 52 deletions doc/README_md.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ <h3>Table of Contents</h3>

<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>
Expand Down Expand Up @@ -116,57 +115,6 @@ <h1 id="label-The+Standup+Doctor">The Standup Doctor<span><a href="#label-The+St

<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>
<ul><li>
<p><a href="#via-rubygems">Via RubyGems</a></p>
</li><li>
<p><a href="#manual-installation">Manual Installation</a></p>
</li></ul>
</li><li>
<p><a href="#usage">Usage</a></p>
<ul><li>
<p><a href="#command-line">Command Line</a></p>
<ul><li>
<p><a href="#cli-examples">CLI Examples</a></p>
<ul><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></ul>
</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>
<ul><li>
<p><a href="#adding-an-entry-for-today">Adding an entry for today</a></p>
</li><li>
<p><a href="#finding-a-past-entry">Finding a past entry</a></p>
</li></ul>
</li><li>
<p><a href="https://evanthegrayt.github.io/standup_md/doc/index.html">Documentation</a></p>
</li></ul>
</li><li>
<p><a href="#vim">Vim</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>
Expand Down
6 changes: 3 additions & 3 deletions doc/created.rid
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Thu, 10 Dec 2020 11:03:50 -0600
README.md Thu, 10 Dec 2020 10:11:00 -0600
Mon, 12 Apr 2021 21:53:43 -0500
README.md Mon, 12 Apr 2021 21:53:19 -0500
lib/standup_md.rb Tue, 13 Oct 2020 21:04:02 -0500
lib/standup_md/cli.rb Tue, 13 Oct 2020 21:04:02 -0500
lib/standup_md/cli/helpers.rb Tue, 13 Oct 2020 21:49:05 -0500
Expand All @@ -9,7 +9,7 @@ lib/standup_md/config/entry.rb Tue, 13 Oct 2020 21:04:02 -0500
lib/standup_md/config/entry_list.rb Wed, 17 Jun 2020 08:47:50 -0500
lib/standup_md/config/file.rb Wed, 17 Jun 2020 08:47:50 -0500
lib/standup_md/entry.rb Tue, 17 Nov 2020 11:34:44 -0600
lib/standup_md/entry_list.rb Tue, 17 Nov 2020 11:34:25 -0600
lib/standup_md/entry_list.rb Mon, 12 Apr 2021 21:51:46 -0500
lib/standup_md/file.rb Tue, 13 Oct 2020 21:04:02 -0500
lib/standup_md/file/helpers.rb Tue, 13 Oct 2020 21:04:02 -0500
lib/standup_md/version.rb Thu, 25 Jun 2020 17:00:46 -0500
51 changes: 0 additions & 51 deletions doc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -117,57 +117,6 @@ <h1 id="label-The+Standup+Doctor">The Standup Doctor<span><a href="#label-The+St

<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>
<ul><li>
<p><a href="#via-rubygems">Via RubyGems</a></p>
</li><li>
<p><a href="#manual-installation">Manual Installation</a></p>
</li></ul>
</li><li>
<p><a href="#usage">Usage</a></p>
<ul><li>
<p><a href="#command-line">Command Line</a></p>
<ul><li>
<p><a href="#cli-examples">CLI Examples</a></p>
<ul><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></ul>
</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>
<ul><li>
<p><a href="#adding-an-entry-for-today">Adding an entry for today</a></p>
</li><li>
<p><a href="#finding-a-past-entry">Finding a past entry</a></p>
</li></ul>
</li><li>
<p><a href="https://evanthegrayt.github.io/standup_md/doc/index.html">Documentation</a></p>
</li></ul>
</li><li>
<p><a href="#vim">Vim</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>
Expand Down
Binary file modified doc/js/search_index.js.gz
Binary file not shown.
2 changes: 0 additions & 2 deletions doc/table_of_contents.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,6 @@ <h2 id="pages">Pages</h2>

<li><a href="README_md.html#label-The+Standup+Doctor">The Standup Doctor</a>

<li><a href="README_md.html#label-Table+of+Contents">Table of Contents</a>

<li><a href="README_md.html#label-About">About</a>

<li><a href="README_md.html#label-Installation">Installation</a>
Expand Down

0 comments on commit 22b836a

Please sign in to comment.