chore: add examples

shengchenyang · May 25, 2024 · fb30533 · fb30533
1 parent c611113
commit fb30533
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,3 +1,21 @@
 # LazyScraper 项目说明
 
-python ayugespidertools 项目结构模版生成。
+## 简介
+
+> 用于 python AyugeSpiderTools 项目结构模版生成。
+
+- 在创建 `scrapy` 项目时，每次都需要配置开发工具，测试工具，`CI/CD` 等内容，非常需要一种方式来快速创建项目模版的方法；
+- `AyugeSpiderTools` 项目现保持结构与 `scrapy` 一致，其他配置和运行等模版则通过此项目实现；
+- 基于 `cookiecutter` 可以很方便地实现个性化项目模版的创建。
+
+## 使用方式
+
+```shell
+# 需要提前安装好 `cookiecutter`
+pip install cookiecutter
+
+# 然后根据 repo 模版生成项目
+cookiecutter https://github.com/shengchenyang/LazyScraper.git
+```
+
+
diff --git a/examples/LazyScraper-result.png b/examples/LazyScraper-result.png
diff --git a/examples/LazyScraper-use.png b/examples/LazyScraper-use.png