about summary refs log tree commit diff stats
diff options
context:
space:
mode:
-rw-r--r--.gitignore1
-rw-r--r--LICENSE13
-rw-r--r--README25
3 files changed, 39 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..f20153b
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+README.org
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..8cb5164
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,13 @@
+Copyright (c) 2020, Andinus <andinus@nand.sh>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
diff --git a/README b/README
new file mode 100644
index 0000000..145e286
--- /dev/null
+++ b/README
@@ -0,0 +1,25 @@
+                               ━━━━━━━━━
+                                 PYXIS
+
+                                Andinus
+                               ━━━━━━━━━
+
+
+Pyxis is a simple twtxt client.
+
+[twtxt] is a decentralised, minimalist microblogging service for
+hackers.
+
+
+[twtxt] https://github.com/buckket/twtxt
+
+
+1 Documentation
+═══════════════
+
+  Pyxis can only follow feeds currently. I'm writing this for fun, more
+  features will be added if I use it.
+
+  The feeds are saved in `$XDG_DATA_HOME/pyxis', if it's not defined
+  then `$HOME/.local/share/pyxis' is used. Feeds are stored in
+  `pyxis.pl', config file will be used later.