diff --git a/README b/README new file mode 100644 index 0000000..32f476b --- /dev/null +++ b/README @@ -0,0 +1,27 @@ +# Parsee - the jealous XMPP<=>Matrix bridge +Parsee is a Matrix<=>XMPP bridge written in C99, with Cytoplasm, similar to Bifrost, +but it is NOT a drop-in replacment. + +## Why? +### Naming +The name 'Parsee' is actually a reference to [Parsee Mizuhashi](https://en.touhouwiki.net/wiki/Parsee_Mizuhashi), a +"*bridge* princess". + +### Reasoning (personal to LDA) +I hate Bifrost. I also wanted to dip my toes in XMPP, XML, and bridges a bit. Also, as a sister project to KappaChat, +this means that I can integrate Parsee with KappaChat however I wish it to be, which allows me to mess around with a +codebase I'm already familiar with. + +~~Also dependency bad.~~ + +## BUILDING +```sh +$ make # This generates a 'parsee' executable. +$ +``` + +## RUNNING +TODO + +## DOCS +TODO