Saffn commited on
Commit
2c75c8a
·
1 Parent(s): ed0edb9

Add prefilled Deploy to Spaces button and clear instructions to README

Browse files
Files changed (1) hide show
  1. README.md +16 -6
README.md CHANGED
@@ -30,19 +30,29 @@ It features a minimalist **Claude-style interface** (built with custom CSS and G
30
 
31
  ## 🛠️ Hugging Face Space Deployment
32
 
33
- Hugging Face restricts the `template` query parameter to a whitelist of official templates. To host your own copy, you have two simple methods:
34
 
35
- ### Method 1: Git Push (Recommended)
36
- 1. Create a new blank Space on [Hugging Face](https://huggingface.co/new-space).
37
- 2. Set the SDK to **Gradio**.
38
- 3. Push these files directly to your Space's repository:
 
 
 
 
 
 
 
 
 
39
  ```bash
40
  git remote add hf https://huggingface.co/spaces/YOUR_HF_USERNAME/YOUR_SPACE_NAME
41
  git push -u hf main --force
42
  ```
43
 
44
  ### Method 2: GitHub Action Auto-Sync (Fully Automated)
45
- You can set up a GitHub Action to automatically sync your GitHub pushes directly to Hugging Face Spaces:
 
46
  1. Create your Space on Hugging Face (SDK: Gradio).
47
  2. Go to your GitHub repository -> **Settings** -> **Secrets and variables** -> **Actions**.
48
  3. Create a **New repository secret**:
 
30
 
31
  ## 🛠️ Hugging Face Space Deployment
32
 
33
+ Click the button below to start your deployment:
34
 
35
+ [![Deploy to Spaces](https://huggingface.co/datasets/huggingface/badges/resolve/main/deploy-to-spaces-lg.svg)](https://huggingface.co/new-space?sdk=gradio)
36
+
37
+ ### How to Deploy in 3 Simple Steps:
38
+ 1. **Create the Space**: Click the button above, type **`llm`** as the Space Name, and click **Create Space** at the bottom of the Hugging Face page.
39
+ 2. **Add your HF_TOKEN Secret**: Go to your GitHub repository -> **Settings** -> **Secrets and variables** -> **Actions** -> Add a secret named `HF_TOKEN` containing your Hugging Face write-access token (from [hf.co/settings/tokens](https://huggingface.co/settings/tokens)).
40
+ 3. **Run GitHub Sync Action**: Go to the **Actions** tab in your GitHub repository, select **Sync to Hugging Face Spaces**, and click **Run workflow**.
41
+
42
+ ---
43
+
44
+ ### Method 1: Manual Git Push
45
+ If you prefer to deploy manually via terminal:
46
+ 1. Create a new blank Space on [Hugging Face](https://huggingface.co/new-space) (SDK: Gradio).
47
+ 2. Push these files directly to your Space's repository:
48
  ```bash
49
  git remote add hf https://huggingface.co/spaces/YOUR_HF_USERNAME/YOUR_SPACE_NAME
50
  git push -u hf main --force
51
  ```
52
 
53
  ### Method 2: GitHub Action Auto-Sync (Fully Automated)
54
+ Your repository is pre-configured with a GitHub Action that automatically syncs code to Hugging Face on every commit:
55
+
56
  1. Create your Space on Hugging Face (SDK: Gradio).
57
  2. Go to your GitHub repository -> **Settings** -> **Secrets and variables** -> **Actions**.
58
  3. Create a **New repository secret**: