From f421dbfe69c24261e4bcd7e29b0d4b4423bfbce4 Mon Sep 17 00:00:00 2001 From: Aria Moradi Date: Fri, 22 Jan 2021 00:34:49 +0330 Subject: [PATCH] Update README.md --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1ec6798..1b9f7f8 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,12 @@ # Tachidesk A free and open source manga reader than runs extensions built for [Tachiyomi](https://tachiyomi.org/) which runs on desktop operating systems. +Ability to read and write Tachiyomi compatible backups and syncing is a planned feature. + +## How does it work? This project has two components: -1. **server:** contains some of the original Tachiyomi code and serves a REST API -2. **webUI:** A react project that works with the server to do the presentation +1. **server:** contains the implementation of [tachiyomi's extensions library](https://github.com/tachiyomiorg/extensions-lib) and uses an Android compatibility library to run apk extensions. All this conclude to serving a REST API to `webUI`. +2. **webUI:** A react SPA project that works with the server to do the presentation. ## How do I run the thing? #### Running pre-built jar packages