Commit
Author: Kevin Schoon [kevinschoon@gmail.com]
Hash: 0a0d35896558beb6b7876d8f6c64919dc90e970c
Timestamp: Sun, 04 Feb 2018 03:30:57 +0000 (6 years ago)

+51 -8 +/-2 browse
update docs
1diff --git a/README.md b/README.md
2index 229d9c3..f859453 100644
3--- a/README.md
4+++ b/README.md
5 @@ -23,9 +23,9 @@ Binaries are available for Linux and OSX platforms in the [releases section](htt
6 #### Linux
7
8 ```
9- curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.4.0/pomo-0.4.0-linux-amd64
10+ curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.5.0/pomo-0.5.0-linux-amd64
11 # Optionally verify file integrity
12- echo 2543baef75c58c01a246e8d79ac59c93 pomo | md5sum -c -
13+ echo 021d59be9a4d625c4e9ee7506c6d7594 pomo | md5sum -c -
14 chmod +x pomo
15 ./pomo -v
16 # Copy pomo to somewhere on your $PATH
17 @@ -34,9 +34,9 @@ chmod +x pomo
18 #### OSX
19
20 ```
21- curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.4.0/pomo-0.4.0-darwin-amd64
22+ curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.5.0/pomo-0.5.0-darwin-amd64
23 # Optionally verify file integrity
24- [[ $(md5 -r pomo) != "7d5217f0e8f792f469a20ae86d4c35c2 pomo" ]] && echo "invalid hash!"
25+ [[ $(md5 -r pomo) != "63370c77f761f38b3c1976e9aaa1e7d3 pomo" ]] && echo "invalid hash!"
26 chmod +x pomo
27 ./pomo -v
28 # Copy pomo to somewhere on your $PATH
29 @@ -81,6 +81,28 @@ Example:
30 }
31 ```
32
33+ ## Integrations
34+
35+ ### Status Bars
36+
37+ The Pomo CLI can output the current state of a running task session via the `pomo status`
38+ making it easy to script and embed it's output in various Linux status bars.
39+
40+ #### [Polybar](https://github.com/jaagr/polybar)
41+
42+ You can create a module with the `custom/script` type and
43+ embed Pomo's status output in your Polybar:
44+
45+ ```
46+ [module/pomo]
47+ type = custom/script
48+ interval = 1
49+ exec = pomo status
50+ label = %output:0:15%
51+ format-underline = ${colors.white}
52+ format-prefix-foreground = ${colors.white}
53+ ```
54+
55
56 ## Roadmap
57
58 diff --git a/docs/index.html b/docs/index.html
59index 43a05ba..4f90ccd 100644
60--- a/docs/index.html
61+++ b/docs/index.html
62 @@ -148,9 +148,9 @@
63
64 <h4 id="linux">Linux</h4>
65
66- <pre><code>curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.4.0/pomo-0.4.0-linux-amd64
67+ <pre><code>curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.5.0/pomo-0.5.0-linux-amd64
68 # Optionally verify file integrity
69- echo 2543baef75c58c01a246e8d79ac59c93 pomo | md5sum -c -
70+ echo 021d59be9a4d625c4e9ee7506c6d7594 pomo | md5sum -c -
71 chmod +x pomo
72 ./pomo -v
73 # Copy pomo to somewhere on your $PATH
74 @@ -158,9 +158,9 @@ chmod +x pomo
75
76 <h4 id="osx">OSX</h4>
77
78- <pre><code>curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.4.0/pomo-0.4.0-darwin-amd64
79+ <pre><code>curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.5.0/pomo-0.5.0-darwin-amd64
80 # Optionally verify file integrity
81- [[ $(md5 -r pomo) != &quot;7d5217f0e8f792f469a20ae86d4c35c2 pomo&quot; ]] &amp;&amp; echo &quot;invalid hash!&quot;
82+ [[ $(md5 -r pomo) != &quot;63370c77f761f38b3c1976e9aaa1e7d3 pomo&quot; ]] &amp;&amp; echo &quot;invalid hash!&quot;
83 chmod +x pomo
84 ./pomo -v
85 # Copy pomo to somewhere on your $PATH
86 @@ -203,6 +203,27 @@ chmod +x pomo
87 }
88 </code></pre>
89
90+ <h2 id="integrations">Integrations</h2>
91+
92+ <h3 id="status-bars">Status Bars</h3>
93+
94+ <p>The Pomo CLI can output the current state of a running task session via the <code>pomo status</code>
95+ making it easy to script and embed it&rsquo;s output in various Linux status bars.</p>
96+
97+ <h4 id="polybar-https-github-com-jaagr-polybar"><a href="https://github.com/jaagr/polybar">Polybar</a></h4>
98+
99+ <p>You can create a module with the <code>custom/script</code> type and
100+ embed Pomo&rsquo;s status output in your Polybar:</p>
101+
102+ <pre><code>[module/pomo]
103+ type = custom/script
104+ interval = 1
105+ exec = pomo status
106+ label = %output:0:15%
107+ format-underline = ${colors.white}
108+ format-prefix-foreground = ${colors.white}
109+ </code></pre>
110+
111 <h2 id="roadmap">Roadmap</h2>
112
113 <ul>