feat: better doc

doc/configuration.md

@@ -0,0 +1,52 @@
+# 配置
+
+要正确使用此程序，需要配置好以下设置：
+
+### TMDB设置
+1. 因为此程序需要使用到 TMDB 的数据，使用此程序首先要申请一个 TMDB 的 Api Key. 申请教程请 google [tmdb api key申请](https://www.google.com/search?q=tmdb+api+key%E7%94%B3%E8%AF%B7)
+
+2. 拿到 TMDB Api Key之后，请填到 *设置 -> 常规设置 -> TMDB Api Key里*
+
+### 索引器
+
+索引器是资源提供者，目前支持 torznab 协议，意味着 polarr 或者 jackett 都可以支持。请自行部署相关程序，或者使用的 docker compose 配置一起拉起
+
+推荐使用 linuxserver 的镜像：https://docs.linuxserver.io/images/docker-jackett/
+
+#### 索引器配置
+
+索引器配置这里以 jackett 为例。使用默认 docker compose 配置拉起后以 http://< ip >:9117 可访问 jackett 的主页。
+
+1. 打开 jackett 主页后，点击页面上面的 Add indexer，会出现 BT/PT 站点列表，选择你需要的站点点击+号添加。如果是PT，请自行配置好相关配置
+
+![add indexer](./assets/add_indexer.png)
+
+![search add](./assets/search_add.png)
+
+
+2. 添加后主页即会显示相应的BT/PT站点，点击 *Copy Torznab Feed* 即得到了我们需要的地址
+
+![copy feed](./assets/copy_feed.png)
+
+3. 回到我们的主程序 Polaris 当中，点击 *设置 -> 索引器设置* -> 点击+号增加新的索引器，输入一个名称，拷贝我们第2步得到的地址到地址栏
+
+![polaris add indexer](./assets/polaris_add_indexer.png)
+
+4. 选相框中我们可以看到，还需要一个 API Key，我们回到 Jackett 中，在页面右上角，复制我们需要的 API Key：
+![api key](./assets/jackett_api_key.png)
+
+5. 恭喜！你已经成功完成了索引器配置。如需要更多的站点，请重复相同的操作完成配置
+
+### 下载器
+
+资源下载器，目前可支持 tansmission，请配置好对应配置
+
+![transmission](./assets/downloader.png)
+
+### 存储设置
+
+默认配置了名为 local 的本地存储，如果你不知道怎么配置。请使用默认配置
+
+![local_storage](./assets/local_storage.png)
+
+类型里选择 webdav 可以使用 webdav 存储，配合 alist/clouddrive 等，可以实现存储到云盘里的功能。

doc/quick_start.md

@@ -0,0 +1,64 @@
+## 快速开始
+
+最简单部署 Polaris 的方式是使用 docker compose，Polaris要完整运行另外需要一个索引客户端和一个下载客户端。索引客户端支持 polarr 或 jackett，下载客户端目前只支持 transmission。
+
+下面是一个示例 docker-compose 配置，为了简单起见，一起拉起了 transmission 和 jackett，你也可选择单独安装
+
+ **注意：** transmission 的下载路径映射要和 polaris 保持一致，如果您不知道怎么做，请保持默认设置。
+
+```yaml
+services:
+  polaris:
+    image: ghcr.io/simon-ding/polaris:latest
+    restart: always
+    volumes:
+      - ./config/polaris:/app/data #程序配置文件路径
+      - /downloads:/downloads #下载路径，需要和下载客户端配置一致
+      - /data:/data #媒体数据存储路径，也可以启动自己配置webdav存储
+    ports:
+      - 8080:8080
+  transmission:    #下载客户端，也可以不安装使用已有的
+    image: lscr.io/linuxserver/transmission:latest
+    environment:
+      - PUID=1000
+      - PGID=1000
+      - TZ=Asia/Shanghai
+    volumes:
+      - ./config/transmission:/config
+      - /downloads:/downloads #此路径要与polaris下载路径保持一致
+    ports:
+      - 9091:9091
+      - 51413:51413
+      - 51413:51413/udp
+  jackett:      #索引客户端，也可以不安装使用已有的
+    image: lscr.io/linuxserver/jackett:latest
+    environment:
+      - PUID=1000
+      - PGID=1000
+      - TZ=Asia/Shanghai
+    volumes:
+      - ./config/jackett:/config
+    ports:
+      - 9117:9117
+    restart: unless-stopped
+```
+
+拉起之后访问 http://< ip >:8080 的形式访问
+
+
+![](./assets/main_page.png)
+
+## 配置
+
+详细配置请看 [配置篇](./configuration.md)
+
+
+## 开始使用
+
+1. 完成配置之后，我们就可以在右上角的搜索按钮里输入我们想看的电影、电视剧。
+2. 找到对应电影电视剧后，点击加入想看列表
+3. 当电影有资源、或者电视剧有更新时，程序就会自动下载对应资源到指定的存储。对于剧集，您也可以进入剧集的详细页面，点击搜索按钮来自己搜索对应集的资源。
+
+到此，您已经基本掌握了此程序的使用方式，请尽情体验吧！
+
+