Skip to content

Commit 80dcaf0

Browse files
committed
Link to installation page
1 parent 5ed4a31 commit 80dcaf0

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,16 @@ JINJA2_ENVIRONMENT_OPTIONS = {
3434
}
3535
```
3636

37-
Note Tidewave only runs in DEBUG mode.
37+
Now make sure [Tidewave is installed](https://hexdocs.pm/tidewave/installation.html) and you are ready to connect Tidewave to your app.
3838

3939
#### Settings
4040

4141
* `ALLOWED_HOSTS` - Tidewave use the same allowed origins as your app to validate access
4242
* `TIDEWAVE["allow_remote_access"]` - Whether to allow remote connections (default `False`)
4343
* `TIDEWAVE["team"]` - Enable your Tidewave Team configuration, such as `TIDEWAVE = {"team": {"id": "dashbit"}}`
4444

45+
Note Tidewave only runs in DEBUG mode.
46+
4547
### Flask
4648

4749
Add `tidewave[flask]` as a dependency to your `pyproject.toml`:
@@ -59,10 +61,10 @@ if app.debug:
5961
tidewave.init_app(app)
6062
```
6163

62-
Tidewave will automatically detect if your Flask application is using SQLAlchemy and Jinja2 and configure them automatically.
63-
6464
Note Tidewave only runs when `app.debug` is `True`. Therefore, remember to start your dev server with the `--debug` flag. If you are setting `app.debug` programatically, remember to do so before you call `tidewave.init_app`.
6565

66+
Now make sure [Tidewave is installed](https://hexdocs.pm/tidewave/installation.html) and you are ready to connect Tidewave to your app.
67+
6668
#### Configuration
6769

6870
When initializing `Tidewave()`, the following options are supported:
@@ -71,6 +73,8 @@ When initializing `Tidewave()`, the following options are supported:
7173
- `allowed_origins:` list of allowed origin hosts (default [])
7274
- `team`: enable Tidewave Web for teams
7375

76+
Tidewave will automatically detect if your Flask application is using SQLAlchemy and Jinja2 and configure them automatically.
77+
7478
### FastAPI
7579

7680
> Tidewave Web is currently not supported for FastAPI.
@@ -111,6 +115,8 @@ tidewave.install(app, sqlalchemy_base=Base, sqlalchemy_engine=engine)
111115

112116
*Note: when using [SQLModel](https://sqlmodel.tiangolo.com/), you should set `sqlalchemy_base=SQLModel`.*
113117

118+
Now make sure [Tidewave is installed](https://hexdocs.pm/tidewave/installation.html) and you are ready to connect Tidewave to your app.
119+
114120
#### Configuration
115121

116122
When initializing `Tidewave()`, the following options are supported:

0 commit comments

Comments
 (0)