about summary refs log tree commit diff
path: root/fun/tvldb/README.md
diff options
context:
space:
mode:
authoreta <eta@theta.eu.org>2020-06-15T20·03+0100
committereta <eta@theta.eu.org>2020-06-16T13·30+0000
commitc3abbb5e2daeec07d03f1addd4a6c905af7a02ac (patch)
tree416ba1be719dd3ebbd15ee41b6f8a2c1b944bd43 /fun/tvldb/README.md
parent4c22cf316933613215e83f70a6bb2c556d42e02c (diff)
feat(tvldb): Import the tvldb/paroxysm source, add a Nix derivation r/993
- This imports the tvldb (actually a thing called 'paroxysm') code
  from https://git.theta.eu.org/eta/paroxysm into the monorepo.
- Additionally, I did a nix thing, yay! \o/
  (well, with tazjin's help)
- 3p/default.nix needed modifying to whitelist pgsql.

Change-Id: Icdf13ca221650dde376f632bd2dd8a087af451bf
Reviewed-on: https://cl.tvl.fyi/c/depot/+/389
Reviewed-by: tazjin <mail@tazj.in>
Diffstat (limited to 'fun/tvldb/README.md')
-rw-r--r--fun/tvldb/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/fun/tvldb/README.md b/fun/tvldb/README.md
new file mode 100644
index 000000000000..a595530982da
--- /dev/null
+++ b/fun/tvldb/README.md
@@ -0,0 +1,19 @@
+paroxysm
+========
+
+`paroxysm` is a bot for [internet relay chat
+(IRC)](https://en.wikipedia.org/wiki/Internet_Relay_Chat) that lets you store
+small pieces of information, called *factoids*, and retrieve them later. It's
+useful for organising frequently-used information to avoid repeating oneself in
+a busy chatroom, as well as making little todo lists or notes to self in a
+private chatroom.
+
+It was directly inspired by the
+[LearnDB](https://github.com/crawl/sequell/blob/master/docs/learndb.md)
+functionality offered in `##crawl` on chat.freenode.net, and uses similar
+syntax.
+
+## Usage instructions
+
+Will come soon; the project is very much still in beta, and is subject to
+change.