NaiJi/kevinschoon-pomo
NaiJi
/
kevinschoon-pomo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update docs

This commit is contained in:
Kevin Schoon 2018-02-03 22:30:57 -05:00
parent 82d8b7d875
commit 0a0d358965
2 changed files with 51 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -23,9 +23,9 @@ Binaries are available for Linux and OSX platforms in the [releases section](htt
#### Linux #### Linux
``` ```
curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.4.0/pomo-0.4.0-linux-amd64 curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.5.0/pomo-0.5.0-linux-amd64
# Optionally verify file integrity # Optionally verify file integrity
echo 2543baef75c58c01a246e8d79ac59c93 pomo | md5sum -c - echo 021d59be9a4d625c4e9ee7506c6d7594 pomo | md5sum -c -
chmod +x pomo chmod +x pomo
./pomo -v ./pomo -v
# Copy pomo to somewhere on your $PATH # Copy pomo to somewhere on your $PATH
@ -34,9 +34,9 @@ chmod +x pomo
#### OSX #### OSX
``` ```
curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.4.0/pomo-0.4.0-darwin-amd64 curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.5.0/pomo-0.5.0-darwin-amd64
# Optionally verify file integrity # Optionally verify file integrity
[[ $(md5 -r pomo) != "7d5217f0e8f792f469a20ae86d4c35c2 pomo" ]] && echo "invalid hash!" [[ $(md5 -r pomo) != "63370c77f761f38b3c1976e9aaa1e7d3 pomo" ]] && echo "invalid hash!"
chmod +x pomo chmod +x pomo
./pomo -v ./pomo -v
# Copy pomo to somewhere on your $PATH # Copy pomo to somewhere on your $PATH
@ -81,6 +81,28 @@ Example:
} }
``` ```
## Integrations
### Status Bars
The Pomo CLI can output the current state of a running task session via the `pomo status`
making it easy to script and embed it's output in various Linux status bars.
#### [Polybar](https://github.com/jaagr/polybar)
You can create a module with the `custom/script` type and
embed Pomo's status output in your Polybar:
```
[module/pomo]
type = custom/script
interval = 1
exec = pomo status
label = %output:0:15%
format-underline = ${colors.white}
format-prefix-foreground = ${colors.white}
```
## Roadmap ## Roadmap

29
docs/index.html
View File

@ -148,9 +148,9 @@
<h4 id="linux">Linux</h4> <h4 id="linux">Linux</h4>
<pre><code>curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.4.0/pomo-0.4.0-linux-amd64 <pre><code>curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.5.0/pomo-0.5.0-linux-amd64
# Optionally verify file integrity # Optionally verify file integrity
echo 2543baef75c58c01a246e8d79ac59c93 pomo | md5sum -c - echo 021d59be9a4d625c4e9ee7506c6d7594 pomo | md5sum -c -
chmod +x pomo chmod +x pomo
./pomo -v ./pomo -v
# Copy pomo to somewhere on your $PATH # Copy pomo to somewhere on your $PATH
@ -158,9 +158,9 @@ chmod +x pomo
<h4 id="osx">OSX</h4> <h4 id="osx">OSX</h4>
<pre><code>curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.4.0/pomo-0.4.0-darwin-amd64 <pre><code>curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.5.0/pomo-0.5.0-darwin-amd64
# Optionally verify file integrity # Optionally verify file integrity
[[ $(md5 -r pomo) != &quot;7d5217f0e8f792f469a20ae86d4c35c2 pomo&quot; ]] &amp;&amp; echo &quot;invalid hash!&quot; [[ $(md5 -r pomo) != &quot;63370c77f761f38b3c1976e9aaa1e7d3 pomo&quot; ]] &amp;&amp; echo &quot;invalid hash!&quot;
chmod +x pomo chmod +x pomo
./pomo -v ./pomo -v
# Copy pomo to somewhere on your $PATH # Copy pomo to somewhere on your $PATH
@ -203,6 +203,27 @@ chmod +x pomo
} }
</code></pre> </code></pre>
<h2 id="integrations">Integrations</h2>
<h3 id="status-bars">Status Bars</h3>
<p>The Pomo CLI can output the current state of a running task session via the <code>pomo status</code>
making it easy to script and embed it&rsquo;s output in various Linux status bars.</p>
<h4 id="polybar-https-github-com-jaagr-polybar"><a href="https://github.com/jaagr/polybar">Polybar</a></h4>
<p>You can create a module with the <code>custom/script</code> type and
embed Pomo&rsquo;s status output in your Polybar:</p>
<pre><code>[module/pomo]
type = custom/script
interval = 1
exec = pomo status
label = %output:0:15%
format-underline = ${colors.white}
format-prefix-foreground = ${colors.white}
</code></pre>
<h2 id="roadmap">Roadmap</h2> <h2 id="roadmap">Roadmap</h2>
<ul> <ul>