Skip to content
This repository was archived by the owner on Dec 9, 2023. It is now read-only.

Commit 8ea2e91

Browse files
committed
Continue the README + more example
1 parent 03c0aa1 commit 8ea2e91

File tree

3 files changed

+60
-2
lines changed

3 files changed

+60
-2
lines changed

README-PREPAR.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ Click on the screenshot to see the config of these examples
117117

118118
## Google Search Console
119119

120-
You can find more examples in the folder `example`.
120+
[<img src="./example/img/gsc-1.png" alt="monitor_widget" type="image/png" >](./example/gsc-1.yml)
121121

122122
## Mix services
123123

@@ -293,7 +293,6 @@ Here's the list of every widgets and their different configuration.
293293
| border_color | Widget's border color | `Default color` | `yellow`, `red` (see colors) |
294294
| text_color | Text color | `Default color` | `yellow`, `red` (see colors) |
295295

296-
### Examples
297296
## Google Search Console
298297

299298
### Service configuration
@@ -376,6 +375,18 @@ You can indicate the width of a widget in number of column, or using the equival
376375
| xl | 10 |
377376
| xxl | 12 |
378377

378+
### Time range
379+
380+
The `start_date` and `end_date` options accept dates following this format: `2016-01-02`.
381+
382+
You can use as well this aliases, relatives to the actual day. This table suppose the actual day is `2019-04-01`
383+
384+
| Name | start_date | end_date |
385+
| -- | -- | |
386+
| this_week | start of the actual week | end of the actual week |
387+
| last_week | start of the last week | end of the last week |
388+
389+
379390
# Contribute
380391

381392
# Licence

example/gsc-1.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
general:
3+
refresh: 600
4+
keys:
5+
quit: "C-c"
6+
7+
projects:
8+
- name: https://web-techno.net
9+
title_options:
10+
border_color: green
11+
text_color: yellow
12+
size: L
13+
bold: true
14+
services:
15+
google_search_console:
16+
keyfile: goanalytics-dace33d3cede.json
17+
address: 'https://web-techno.net'
18+
widgets:
19+
- row:
20+
- col:
21+
size: 12
22+
elements:
23+
- name: gsc.table_queries
24+
options:
25+
title: " Last month queries "
26+
start_date: "last_month"
27+
end_date: "last_month"
28+
character_limit: 25
29+
row_limit: 10
30+
metrics: "clicks,impressions"
31+
border_color: green
32+
title_color: green
33+
text_color: green
34+
- row:
35+
- col:
36+
size: 12
37+
elements:
38+
- name: gsc.table_pages
39+
options:
40+
title: " Last month pages "
41+
start_date: "last_month"
42+
end_date: "last_month"
43+
character_limit: 25
44+
row_limit: 10
45+
border_color: yellow
46+
title_color: yellow
47+
text_color: yellow

example/img/gsc-1.png

78.9 KB
Loading

0 commit comments

Comments
 (0)