Skip to content

docs: Add Core example to readme #107

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
merged 1 commit into from
Jul 10, 2025
Merged

docs: Add Core example to readme #107

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,23 @@ import urllib.parse
new_secret = urllib.parse.quote_plus(my_secret)
```

## Connecting with Firebolt Core

[Firebolt Core](https://docs.firebolt.io/firebolt-core) is free self-hosted version of Firebolt.

In order to connect to it you can provide a simplified version of the connection string:

```
firebolt://{database}?url={url}
```

`{database}` is you Firebolt Core database. By default this is `firebolt`

`{url}` is a fully qualified URL (with port) where your Firebolt Core is hosted. By default it's `http://localhost:3473`

If you are running Firebolt Core locally with defaults the connection string will be `firebolt://firebolt?url=http://localhost:3473`


## Quick Start

```python
Expand Down