the Pipa Index ·
elixir
r/o

pipa / README.md

1
# Pipa
2
3
* [Getting started](https://nossa.ee/~talya/pipa/#getting-started)
4
* [Features](https://nossa.ee/~talya/pipa/#features)
5
6
The Pipa Index.
7
8
A [Greasemonkey script](gm.js) inserts this little guy:
9
10
![](priv/static/images/pipa.png)
11
12
... onto pages of your choosing:
13
14
![](help/pipa-on-page.png)
15
16
He will take you to the Pipa Index for that page:
17
18
![](help/pipa-index.png)
19
20
Page isn't in the Index? The Pipa is angry!
21
22
![](help/angry-pipa.png)
23
24
Do not be alarmed. He will invite you to create a new entry in the Pipa Index:
25
26
![](help/calm-the-pipa.png)
27
28
The columns in the Index are defined by you.
29
30
![](help/columns.png)
31
32
All changes are saved in an event log.
33
34
![](help/events.png)
35
36
37
## <a id="getting-started"></a>Getting started
38
39
This section is TODO, but I'm including it now to record things that will be
40
useful for it.
41
42
Serving suggestion for "User matches":
43
44
```
45
https://gitlab.com/*
46
https://dev.gitlab.org/*
47
https://github.com/*
48
```
49
50
Serving suggestion for "User excludes" (so you don't get Pipa appearing in
51
iframes):
52
53
```
54
https://gitlab.com/-/sandbox/mermaid*
55
```
56
57
Serving suggestion for "User domain whitelist" (to be used with a `pipa.index`
58
entry in `/etc/hosts`):
59
60
```
61
pipa.index
62
```
63
64
65
## <a id="features"></a>Features
66
67
* Greasemonkey script to insert the Pipa on target pages.
68
* Link multiple URLs to a single entry to tie them together.
69
* Define columns for each entry; can also be used to sort.
70
* Add comments to entries; supports image attachments.
71
* All changes recorded in a per-entry event log.
72
* Supports gitlab.com and github.com for most activities:
73
* Friendly display of URLs.
74
* Cache MR/issue status via API.
75
76
See [TODO](TODO) for what might come next.
77
78
79
## Contact
80
81
@kivikakk on Slack if you're tanuki, otherwise <ashe@kivikakk.ee>.
82