From fd037c8469c714faf385536d7d67d427bb031937 Mon Sep 17 00:00:00 2001
From: AIboy996 <2207854887@qq.com>
Date: Wed, 22 May 2024 23:52:38 +0800
Subject: [PATCH] [update] readme

---
 docs/index.md   | 9 ++++++++-
 readme.md       | 9 ++++++++-
 site/index.html | 8 ++++++--
 3 files changed, 22 insertions(+), 4 deletions(-)

diff --git a/docs/index.md b/docs/index.md
index cfe0276..f3197c5 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -20,9 +20,16 @@ You should install the package with pip:
 pip install mkdocs-ai-summary[tongyi]
 ```
 
+> ⚠️⚠️⚠️⚠️
+> 
 > Only support [tongyi ai](https://tongyi.aliyun.com/) for now. **Soon to support ChatGPT.**
+>  
+>  To use tongyi ai, you should set a Environmental Variable for **api key**:
+>  ```bash
+>  export DASHSCOPE_API_KEY='sk-xxxxxxx'
+>  ```
 
-And you should include the [ai-summary.css](./ai-summary.css)(optional, this is for the **custom admonition style**) in the config file as below:
+[optional] Then you can include the [ai-summary.css](./ai-summary.css)(optional, this is for the **custom admonition style**) in the config file as below:
 
 ## Configuration
 
diff --git a/readme.md b/readme.md
index 5016518..77cc661 100644
--- a/readme.md
+++ b/readme.md
@@ -18,9 +18,16 @@ You should install the package with pip:
 pip install mkdocs-ai-summary[tongyi]
 ```
 
+> ⚠️⚠️⚠️⚠️
+> 
 > Only support [tongyi ai](https://tongyi.aliyun.com/) for now. **Soon to support ChatGPT.**
+>  
+>  To use tongyi ai, you should set a Environmental Variable for **api key**:
+>  ```bash
+>  export DASHSCOPE_API_KEY='sk-xxxxxxx'
+>  ```
 
-And you should include the [ai-summary.css](./docs/ai-summary.css)(optional, this is for the **custom admonition style**) in the config file as below:
+[optional] Then you can include the [ai-summary.css](./docs/ai-summary.css)(optional, this is for the **custom admonition style**) in the config file as below:
 
 ## Configuration
 
diff --git a/site/index.html b/site/index.html
index 4d8fef5..e4d6651 100644
--- a/site/index.html
+++ b/site/index.html
@@ -296,7 +296,7 @@
 <h1 id="mkdocs-ai-summary">mkdocs-ai-summary</h1>
 <div class="admonition ai-summary">
 <p class="admonition-title">AI摘要 powered by <a href="https://tongyi.aliyun.com/">通义千问</a></p>
-<p><code>mkdocs-ai-summary</code> is a Python package that generates AI-generated summaries for MkDocs pages using Tongyi AI. It supports live demos on <a href="https://yangzhang.site">yangzhang.site</a> and is compatible with Tongyi AI only, soon to include ChatGPT. Install with pip, and include <code>ai-summary.css</code> (optional). Configure in <code>mkdocs.yml</code> by adding meta tags to pages. Caching ensures efficient re-use of summaries when content remains unchanged.</p>
+<p><code>mkdocs-ai-summary</code> is a plugin for generating AI-generated summaries on MkDocs pages using Tongyi AI. Install with pip and configure via a <code>mkdocs.yml</code> file, setting an API key for Tongyi. Add an AI summary to each page using a meta tag. The plugin supports caching to minimize API calls, with plans to expand to ChatGPT support. Live demo at <a href="https://yangzhang.site">yangzhang.site</a>.</p>
 </div>
 <p><a href="https://pypi.org/project/mkdocs-ai-summary/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/mkdocs-ai-summary" /></a>
 <img alt="PyPI - Implementation" src="https://img.shields.io/pypi/implementation/mkdocs-ai-summary" />
@@ -309,9 +309,13 @@ <h2 id="installation">Installation</h2>
 <div class="highlight"><pre><span></span><code>pip install mkdocs-ai-summary[tongyi]
 </code></pre></div></p>
 <blockquote>
+<p>⚠️⚠️⚠️⚠️</p>
 <p>Only support <a href="https://tongyi.aliyun.com/">tongyi ai</a> for now. <strong>Soon to support ChatGPT.</strong></p>
+<p>To use tongyi ai, you should set a Environmental Variable for <strong>api key</strong>:
+ <div class="highlight"><pre><span></span><code><span class="nb">export</span><span class="w"> </span><span class="nv">DASHSCOPE_API_KEY</span><span class="o">=</span><span class="s1">&#39;sk-xxxxxxx&#39;</span>
+</code></pre></div></p>
 </blockquote>
-<p>And you should include the <a href="ai-summary.css">ai-summary.css</a>(optional, this is for the <strong>custom admonition style</strong>) in the config file as below:</p>
+<p>[optional] Then you can include the <a href="ai-summary.css">ai-summary.css</a>(optional, this is for the <strong>custom admonition style</strong>) in the config file as below:</p>
 <h2 id="configuration">Configuration</h2>
 <p>A demo for <code>mkdocs.yml</code>:</p>
 <div class="highlight"><pre><span></span><code>site_name: mkdocs-ai-summary