From c1365d1539aa80002d994b89658a5e562d00f862 Mon Sep 17 00:00:00 2001
From: yanqs <git@yanqingshan.com>
Date: Mon, 12 Aug 2024 09:47:24 +0800
Subject: [PATCH] =?UTF-8?q?init:=E6=96=B0=E5=A2=9E=E9=A1=B9=E7=9B=AE?=
 =?UTF-8?q?=E8=AF=B4=E6=98=8E?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .gitignore | 44 ++++++++++++++++++++++++++++++++++++++++++++
 README.md  | 28 ++++++++++++++++++++++++++++
 2 files changed, 72 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..41727f2
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,44 @@
+target/
+!.mvn/wrapper/maven-wrapper.jar
+!**/src/main/**/target/
+!**/src/test/**/target/
+
+### IntelliJ IDEA ###
+.idea/modules.xml
+.idea/jarRepositories.xml
+.idea/compiler.xml
+.idea/libraries/
+.idea
+*.iws
+*.iml
+*.ipr
+
+### Eclipse ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+build/
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### VS Code ###
+.vscode/
+
+### Mac OS ###
+.DS_Store
+
+### CodeArts IDE
+.arts
+.jlsp
+
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2110296
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# rss-reader
+
+RSS阅读器，基于Java SpringBoot搭建。
+
+## 部署运行
+
+```shell
+docker run -d --restart=always \
+-v ./config:/app/config \
+-v ./log:/app/log \
+-v ./images:/app/images \
+-v /etc/localtime:/etc/localtime:ro \
+--name rss-reader \
+bcrjl/rss-reader:latest
+```
+
+打开`data.json`配置需要订阅的RSS源;打开`config.setting`配置系统参数;
+
+以上配置均为动态刷新，无需重启容器
+
+### 映射目录说明
+
+| 本地目录 | 容器目录 | 说明    |
+| --- | --- |-------|
+| ./config | /app/config | 配置文件  |
+| ./log | /app/log | 运行日志  |
+| ./images | /app/images | 下载的文件 |
+