Skip to content

Commit 9ea3614

Browse files
julien040julien040
committed
✏️ Fix configuration text in README.md of carddav
1 parent 43adae1 commit 9ea3614

File tree

2 files changed

+48
-50
lines changed

2 files changed

+48
-50
lines changed

‎plugins/carddav/README.md‎

Lines changed: 47 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -31,33 +31,31 @@ WHERE address_book = 'contacts/' AND uid = 'unique-id-123';
3131
anyquery install carddav
3232
```
3333

34-
## Configuration
35-
36-
The plugin requires CardDAV server credentials:
37-
38-
```bash
39-
anyquery config set carddav url "https://carddav.example.com"
40-
anyquery config set carddav username "your_username"
41-
anyquery config set carddav password "your_password"
42-
```
34+
Anyquery will ask you for your CardDAV server URL, username, and password during installation. Refer to the [guide](#popular-carddav-providers) below for more information on how to configure your CardDAV server.
4335

4436
### Popular CardDAV Providers
4537

4638
#### Nextcloud
47-
```
39+
40+
```txt
4841
URL: https://your-nextcloud.com/remote.php/dav/addressbooks/users/yourusername/
4942
```
43+
5044
Create an app-specific password in Settings → Security → App passwords.
5145

5246
#### Google Contacts
5347

54-
Enable CardDAV API in Google Admin Console (for Workspace accounts) or use Google Contacts API instead.
48+
Enable CardDAV API in Google Admin Console (for Workspace accounts). The Google Contacts API is not supported, but you can use Anyquery's integration for [Google Contacts](https://anyquery.dev/integrations/google_contacts).
5549

5650
#### Apple iCloud
57-
```
51+
52+
```txt
5853
URL: https://contacts.icloud.com/
54+
Username: The email used by your Apple account
55+
Password: Your Apple ID password
5956
```
60-
Use an app-specific password from Apple ID settings.
57+
58+
Use an app-specific password from Apple ID settings. Refer to [Apple's documentation](https://support.apple.com/en-au/102654#:~:text=Sign%20in%20to%20your%20Apple%20Account%20on%20account.apple.com,the%20steps%20on%20your%20screen.)
6159

6260
## Tables
6361

@@ -67,49 +65,49 @@ List available address books on the CardDAV server.
6765

6866
#### Schema
6967

70-
| Column index | Column name | Type | Description |
71-
| ------------ | ----------------- | ------- | ------------------------------------- |
72-
| 0 | path | TEXT | Address book path (use for queries) |
73-
| 1 | name | TEXT | Display name of the address book |
74-
| 2 | description | TEXT | Description of the address book |
75-
| 3 | max_resource_size | INTEGER | Maximum resource size |
68+
| Column index | Column name | Type | Description |
69+
| ------------ | ----------------- | ------- | ----------------------------------- |
70+
| 0 | path | TEXT | Address book path (use for queries) |
71+
| 1 | name | TEXT | Display name of the address book |
72+
| 2 | description | TEXT | Description of the address book |
73+
| 3 | max_resource_size | INTEGER | Maximum resource size |
7674

7775
### `carddav_contacts`
7876

7977
Query and manage contacts from CardDAV address books.
8078

8179
#### Schema
8280

83-
| Column index | Column name | Type | Description |
84-
| ------------ | ---------------- | ------ | ------------------------------ |
85-
| 0 | address_book | TEXT | Address book path (parameter) |
86-
| 1 | uid | TEXT | Unique identifier |
87-
| 2 | etag | TEXT | ETag for conflict detection |
88-
| 3 | path | TEXT | CardDAV resource path |
89-
| 4 | full_name | TEXT | Full display name |
90-
| 5 | given_name | TEXT | First name |
91-
| 6 | family_name | TEXT | Last name |
92-
| 7 | middle_name | TEXT | Middle name |
93-
| 8 | prefix | TEXT | Name prefix (Mr., Dr., etc.) |
94-
| 9 | suffix | TEXT | Name suffix (Jr., Sr., etc.) |
95-
| 10 | nickname | TEXT | Nickname |
96-
| 11 | email | TEXT | Primary email address |
97-
| 12 | home_email | TEXT | Home email address |
98-
| 13 | work_email | TEXT | Work email address |
99-
| 14 | other_email | TEXT | Other email address |
100-
| 15 | emails | TEXT | All emails (JSON array) |
101-
| 16 | phone | TEXT | Primary phone number |
102-
| 17 | mobile_phone | TEXT | Mobile phone number |
103-
| 18 | work_phone | TEXT | Work phone number |
104-
| 19 | organization | TEXT | Organization/Company |
105-
| 20 | title | TEXT | Job title |
106-
| 21 | role | TEXT | Role/Position |
107-
| 22 | birthday | TEXT | Birthday (YYYY-MM-DD) |
108-
| 23 | anniversary | TEXT | Anniversary (YYYY-MM-DD) |
109-
| 24 | note | TEXT | Notes |
110-
| 25 | url | TEXT | Website URL |
111-
| 26 | categories | TEXT | Categories (JSON array) |
112-
| 27 | modified_at | TEXT | Last modified timestamp |
81+
| Column index | Column name | Type | Description |
82+
| ------------ | ------------ | ---- | ----------------------------- |
83+
| 0 | address_book | TEXT | Address book path (parameter) |
84+
| 1 | uid | TEXT | Unique identifier |
85+
| 2 | etag | TEXT | ETag for conflict detection |
86+
| 3 | path | TEXT | CardDAV resource path |
87+
| 4 | full_name | TEXT | Full display name |
88+
| 5 | given_name | TEXT | First name |
89+
| 6 | family_name | TEXT | Last name |
90+
| 7 | middle_name | TEXT | Middle name |
91+
| 8 | prefix | TEXT | Name prefix (Mr., Dr., etc.) |
92+
| 9 | suffix | TEXT | Name suffix (Jr., Sr., etc.) |
93+
| 10 | nickname | TEXT | Nickname |
94+
| 11 | email | TEXT | Primary email address |
95+
| 12 | home_email | TEXT | Home email address |
96+
| 13 | work_email | TEXT | Work email address |
97+
| 14 | other_email | TEXT | Other email address |
98+
| 15 | emails | TEXT | All emails (JSON array) |
99+
| 16 | phone | TEXT | Primary phone number |
100+
| 17 | mobile_phone | TEXT | Mobile phone number |
101+
| 18 | work_phone | TEXT | Work phone number |
102+
| 19 | organization | TEXT | Organization/Company |
103+
| 20 | title | TEXT | Job title |
104+
| 21 | role | TEXT | Role/Position |
105+
| 22 | birthday | TEXT | Birthday (YYYY-MM-DD) |
106+
| 23 | anniversary | TEXT | Anniversary (YYYY-MM-DD) |
107+
| 24 | note | TEXT | Notes |
108+
| 25 | url | TEXT | Website URL |
109+
| 26 | categories | TEXT | Categories (JSON array) |
110+
| 27 | modified_at | TEXT | Last modified timestamp |
113111

114112
## Development
115113

‎plugins/carddav/manifest.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name = "carddav"
33
version = "0.1.0"
44
description = "Query and manage CardDAV contacts with SQL"
5-
author = "Anyquery Team"
5+
author = "offlinehacker"
66
license = "UNLICENSED"
77
repository = "https://github.com/julien040/anyquery/tree/main/plugins/carddav"
88
homepage = "https://github.com/julien040/anyquery/tree/main/plugins/carddav"

0 commit comments

Comments
 (0)