diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 5ad909b..7a69d1d 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -26,7 +26,7 @@ jobs: run: npm run build - name: Copy README to dist - run: cp README.md dist/ + run: cp README_HF.md dist/README.md - name: Push to Hugging Face Spaces env: diff --git a/README.md b/README.md index 7e61ae1..c55e865 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,16 @@ ---- -title: WebLLM Playground -emoji: 🏎️ -colorFrom: purple -colorTo: indigo -sdk: static -pinned: true -header: mini -license: apache-2.0 ---- ![WebLLM Playground](https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/webllm/WebLLM.png)
-**WebLLM Playground** is built on top of [MLC-LLM](https://github.com/mlc-ai/mlc-llm) and [WebLLM Chat](https://github.com/mlc-ai/web-llm-chat). +**WebLLM Playground** is built on top of [MLC-LLM](https://github.com/mlc-ai/mlc-llm), [WebLLM](https://github.com/mlc-ai/web-llm), and [WebLLM Chat](https://github.com/mlc-ai/web-llm-chat). [![NPM Package](https://img.shields.io/badge/NPM_Package-Published-cc3534)](https://www.npmjs.com/package/@mlc-ai/web-llm) -[!["WebLLM Chat Deployed"](https://img.shields.io/badge/WebLLM_Chat-Deployed-%2332a852)](https://chat.webllm.ai/) +[!["WebLLM Chat"](https://img.shields.io/badge/WebLLM_Chat-Deployed-%2332a852)](https://chat.webllm.ai/) [![Join Discoard](https://img.shields.io/badge/Join-Discord-7289DA?logo=discord&logoColor=white)]("https://discord.gg/9Xpy2HGBuD") +[![Related Repository: WebLLM](https://img.shields.io/badge/Related_Repo-WebLLM-fafbfc?logo=github)](https://github.com/mlc-ai/web-llm/) [![Related Repository: WebLLM Chat](https://img.shields.io/badge/Related_Repo-WebLLM_Chat-fafbfc?logo=github)](https://github.com/mlc-ai/web-llm-chat/) [![Related Repository: MLC LLM](https://img.shields.io/badge/Related_Repo-MLC_LLM-fafbfc?logo=github)](https://github.com/mlc-ai/mlc-llm/) + --- diff --git a/README_HF.md b/README_HF.md new file mode 100644 index 0000000..c5f7e41 --- /dev/null +++ b/README_HF.md @@ -0,0 +1,23 @@ +--- +title: WebLLM Playground +emoji: 🏎️ +colorFrom: purple +colorTo: indigo +sdk: static +pinned: true +header: mini +license: apache-2.0 +--- +![WebLLM Playground](https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/webllm/WebLLM.png) + +
+ +**WebLLM Playground** is built on top of [MLC-LLM](https://github.com/mlc-ai/mlc-llm), [WebLLM](https://github.com/mlc-ai/web-llm), and [WebLLM Chat](https://github.com/mlc-ai/web-llm-chat). + +[![NPM Package](https://img.shields.io/badge/NPM_Package-Published-cc3534)](https://www.npmjs.com/package/@mlc-ai/web-llm) +[!["WebLLM Chat"](https://img.shields.io/badge/WebLLM_Chat-Deployed-%2332a852)](https://chat.webllm.ai/) +[![Join Discoard](https://img.shields.io/badge/Join-Discord-7289DA?logo=discord&logoColor=white)]("https://discord.gg/9Xpy2HGBuD") +[![Related Repository: WebLLM](https://img.shields.io/badge/Related_Repo-WebLLM-fafbfc?logo=github)](https://github.com/mlc-ai/web-llm/) +[![Related Repository: WebLLM Chat](https://img.shields.io/badge/Related_Repo-WebLLM_Chat-fafbfc?logo=github)](https://github.com/mlc-ai/web-llm-chat/) +[![Related Repository: MLC LLM](https://img.shields.io/badge/Related_Repo-MLC_LLM-fafbfc?logo=github)](https://github.com/mlc-ai/mlc-llm/) +