first commit

1 files changed, 23 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..58a1247
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# animedb
+
+A personal anime tracker with statically generated web displays.
+
+Thought up during MAL's sudden and unusual hiatus in which they forced every user account to reset their password and denied access to their service for days.
+
+I want a personalised way if displaying my anime history and progress without relying on a third party being online. 
+
+# project goals
+
+* single user, this is not a community tracker 
+* static webpages generated with scripts
+* no javascript, php or cgi (html and css web pages only)
+* usable on mobile and browser
+* display anime with information about it (name, year created, rating, genre, number of episodes etc)
+* display user rating, episodes watched, personal notes etc)
+* source information from MAL API (maybe others, I don't know of any) or allow the user to enter it manually
+* sqlite database to hold the information
+* provide easy to use cli tool to update/add anime, episodes, rating, notes etc
+* no servers, all edits to the database will be local
+* provide filters (highest/lowest score first, date created, watch status (watching, finished, on hold etc)
+  * these will be generated html pages
+* script to import anime from MAL profiles (maybe others, again I don't know any personally)