Skip to content

docs: use INI format in README Quick Start config example #221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jennlu330 merged 2 commits into from
Sep 3, 2026
Merged

docs: use INI format in README Quick Start config example #221

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4108bef
docs: use INI format in README Quick Start config example
cody-rester Sep 2, 2026
e5a0f62
docs: show default_profile and explicit verify in README config example
cody-rester Sep 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,20 @@ make build

### Configure

Create `~/.platform.d/config.toml` with a server profile:
Create `~/.platform.d/config.ini` with a server profile, and set it as the
default profile so it's used automatically without passing `--profile`:

```toml
["profile default"]
host = "platform.example.com"
```ini
[application]
default_profile = local

[profile local]
host = platform.example.com
port = 443
use_tls = true
username = "admin"
password = "your-password"
verify = true
username = admin
password = your-password
```

### Use
Expand Down