about summary refs log tree commit diff
path: root/fun/paroxysm/README.md
diff options
context:
space:
mode:
authorVincent Ambo <mail@tazj.in>2020-07-27T19·45+0100
committertazjin <mail@tazj.in>2020-07-27T23·54+0000
commit82ba28f1976305c1163adb5993745604ccb696cc (patch)
tree6d3887b3ffd1213461d8f612549bfaeda46a0657 /fun/paroxysm/README.md
parentef54f5da9fa30b5c302f2a49595ee5d041f9706a (diff)
chore: Move //fun/tvldb -> //fun/paroxysm r/1496
Say ~my~ its name!

Change-Id: I7890318aef984af0f6bc011de32282f16e01cbb3
Reviewed-on: https://cl.tvl.fyi/c/depot/+/1483
Tested-by: BuildkiteCI
Reviewed-by: eta <eta@theta.eu.org>
Diffstat (limited to 'fun/paroxysm/README.md')
-rw-r--r--fun/paroxysm/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/fun/paroxysm/README.md b/fun/paroxysm/README.md
new file mode 100644
index 000000000000..a595530982da
--- /dev/null
+++ b/fun/paroxysm/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.