Skip to content

Commit 8e6eb6c

Browse files
committed
docs: update readme
1 parent a86475b commit 8e6eb6c

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Once installed, the macro functions provided by the extension can be used just l
3030

3131
This function extracts the main domain from a URL. For this purpose, the extension will get all public suffixes from the [publicsuffix.org](https://publicsuffix.org/) list and extract the main domain from the URL.
3232

33-
The download process of the public suffix list is done automatically when the function called for the first time. After that, the list is stored in the `public_suffix_list` table to avoid downloading it again.
33+
The download process of the public suffix list is done automatically when the function is called for the first time. After that, the list is stored in the `public_suffix_list` table to avoid downloading it again.
3434

3535
```sql
3636
D SELECT extract_domain('a.example.com') as domain;
@@ -214,7 +214,7 @@ D SELECT extract_subdomain('test.example.com.ac') as dns_record;
214214
This function returns the [Tranco](https://tranco-list.eu/) rank of a domain. You have a `update_tranco` function to update the Tranco list manually.
215215

216216
```sql
217-
D select update_tranco(true);
217+
D SELECT update_tranco(true);
218218
┌─────────────────────────────────────┐
219219
│ update_tranco(CAST('f' AS BOOLEAN)) │
220220
varchar
@@ -228,7 +228,7 @@ This function will get the latest Tranco list and save it into the `tranco_list`
228228
You can ignore the file and force the extension to download the list again by calling the function with `true` as a parameter. If you don't want to download the list again, you can call the function with `false` as a parameter.
229229

230230
```sql
231-
D select update_tranco(false);
231+
D SELECT update_tranco(false);
232232
```
233233

234234
As the latest Tranco list is for the last day, you can download your list manually and rename it to `tranco_lit_%Y-%m-%d.csv` to use it with the extension too.
@@ -238,15 +238,15 @@ As the latest Tranco list is for the last day, you can download your list manual
238238
You can use this function to get the ranking of a domain:
239239

240240
```sql
241-
D select get_tranco_rank('microsoft.com') as rank;
241+
D SELECT get_tranco_rank('microsoft.com') as rank;
242242
┌───────┐
243243
│ rank │
244244
│ int32 │
245245
├───────┤
246246
2
247247
└───────┘
248248

249-
D select get_tranco_rank('cloudflare.com') as rank;
249+
D SELECT get_tranco_rank('cloudflare.com') as rank;
250250
┌───────┐
251251
│ rank │
252252
│ int32 │
@@ -257,6 +257,7 @@ D select get_tranco_rank('cloudflare.com') as rank;
257257

258258
## Roadmap 🗺️
259259

260+
- [ ] Create a version function `SELECT * from netquack_version();`
260261
- [ ] Create a `TableFunction` for `extract_query_parameters` that return each key-value pair as a row.
261262
- [ ] Save Tranco data as Parquet
262263
- [ ] Create Rank category for Tranco ( `top1k` , `top5k`, `top10k`, `top100k`, `top500k`, `top1m` )

0 commit comments

Comments
 (0)