Skip to content

Commit 710be4a

Browse files
authored
docs: expand README usage examples cookbook
1 parent f7eda9a commit 710be4a

1 file changed

Lines changed: 85 additions & 19 deletions

File tree

README.md

Lines changed: 85 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -59,44 +59,110 @@ Headers for successful responses:
5959
6060
## ✨ Examples
6161

62-
![](https://geps.dev/progress/10)
62+
> [!TIP]
63+
> Every snippet below is ready to paste into GitHub Markdown.
6364
64-
![](https://geps.dev/progress/50)
65+
### 1) Integer percentage
6566

66-
![](https://geps.dev/progress/75)
67+
![](https://geps.dev/progress/10)
68+
69+
> [!NOTE]
70+
> URL: `https://geps.dev/progress/10`
71+
> Markdown:
72+
> ```md
73+
> ![](https://geps.dev/progress/10)
74+
> ```
6775
68-
Float percentage:
76+
### 2) Float percentage
6977
7078
![](https://geps.dev/progress/76.5)
7179
72-
### Custom colors
80+
> [!NOTE]
81+
> URL: `https://geps.dev/progress/76.5`
82+
> Markdown:
83+
> ```md
84+
> ![](https://geps.dev/progress/76.5)
85+
> ```
7386
74-
You can customize colors through query params:
87+
### 3) Automatic clamping (>100)
7588
76-
- `dangerColor`
77-
- `warningColor`
78-
- `successColor`
89+
![](https://geps.dev/progress/150)
7990
80-
```md
81-
![](https://geps.dev/progress/32?dangerColor=800000&warningColor=ff9900&successColor=006600)
82-
```
91+
> [!NOTE]
92+
> URL: `https://geps.dev/progress/150`
93+
> Markdown:
94+
> ```md
95+
> ![](https://geps.dev/progress/150)
96+
> ```
8397
84-
Rendered examples:
98+
### 4) Automatic clamping (<0)
8599
86-
![](https://geps.dev/progress/10?dangerColor=800000&warningColor=ff9900&successColor=006600)
100+
![](https://geps.dev/progress/-10)
87101
88-
![](https://geps.dev/progress/50?dangerColor=800000&warningColor=ff9900&successColor=006600)
102+
> [!NOTE]
103+
> URL: `https://geps.dev/progress/-10`
104+
> Markdown:
105+
> ```md
106+
> ![](https://geps.dev/progress/-10)
107+
> ```
108+
109+
### 5) Custom threshold colors (`dangerColor`, `warningColor`, `successColor`)
89110
111+
![](https://geps.dev/progress/10?dangerColor=800000&warningColor=ff9900&successColor=006600)
112+
![](https://geps.dev/progress/50?dangerColor=800000&warningColor=ff9900&successColor=006600)
90113
![](https://geps.dev/progress/75?dangerColor=800000&warningColor=ff9900&successColor=006600)
91114
92-
### Data bar mode (from arbitrary numeric range)
115+
> [!NOTE]
116+
> URL pattern: `https://geps.dev/progress/{value}?dangerColor=800000&warningColor=ff9900&successColor=006600`
117+
> Markdown:
118+
> ```md
119+
> ![](https://geps.dev/progress/50?dangerColor=800000&warningColor=ff9900&successColor=006600)
120+
> ```
93121
94-
```md
95-
![](https://geps.dev/progress/186?label=186&min=0&max=241&barColor=4472C4)
96-
```
122+
### 6) Fixed bar color (`barColor`)
123+
124+
![](https://geps.dev/progress/50?barColor=4472C4)
125+
126+
> [!NOTE]
127+
> URL: `https://geps.dev/progress/50?barColor=4472C4`
128+
> Markdown:
129+
> ```md
130+
> ![](https://geps.dev/progress/50?barColor=4472C4)
131+
> ```
132+
133+
### 7) Data-bar mode (`min` + `max` + `label` + `barColor`)
97134
98135
![](https://geps.dev/progress/186?label=186&min=0&max=241&barColor=4472C4)
99136
137+
> [!NOTE]
138+
> URL: `https://geps.dev/progress/186?label=186&min=0&max=241&barColor=4472C4`
139+
> Markdown:
140+
> ```md
141+
> ![](https://geps.dev/progress/186?label=186&min=0&max=241&barColor=4472C4)
142+
> ```
143+
144+
### 8) Data-bar mode with default label (raw value)
145+
146+
![](https://geps.dev/progress/50?min=0&max=200)
147+
148+
> [!NOTE]
149+
> URL: `https://geps.dev/progress/50?min=0&max=200`
150+
> Markdown:
151+
> ```md
152+
> ![](https://geps.dev/progress/50?min=0&max=200)
153+
> ```
154+
155+
### 9) Custom text label in percentage mode
156+
157+
![](https://geps.dev/progress/70?label=Sprint%201)
158+
159+
> [!NOTE]
160+
> URL: `https://geps.dev/progress/70?label=Sprint%201`
161+
> Markdown:
162+
> ```md
163+
> ![](https://geps.dev/progress/70?label=Sprint%201)
164+
> ```
165+
100166
## 🛠️ Local Development
101167
102168
### Prerequisites

0 commit comments

Comments
 (0)