Skip to content

Commit eb4f461

Browse files
committed
Add more context to the README
1 parent 7714a40 commit eb4f461

1 file changed

Lines changed: 18 additions & 8 deletions

File tree

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,25 @@
11
# Tidewave
22

3-
> Tidewave Web for Next.js is currently in alpha testing!
3+
> Tidewave Web for Next.js and React+Vite is currently in alpha testing!
44
55
Tidewave is the coding agent for full-stack web app development.
66
[See our website](https://tidewave.ai) for more information.
77

8-
This package is recommended for JavaScript-powered backends as well as
9-
JavaScript libraries/applications using a backend as a service (such as
10-
Supabase). If you are using React with Phoenix, Rails, Django, or another
11-
server-side framework, [follow the steps here instead](http://hexdocs.pm/tidewave/react.html).
8+
If you are using Next.js or you have a React + Vite frontend, talking
9+
either to a backend as a service (such as Supabase) or a third-party
10+
framework, you are in the right place!
1211

13-
This project can also be used as a standalone Model Context Protocol (MCP)
14-
server for your editors.
12+
If you are using React with Django, FastAPI, Flask, Phoenix, or Rails,
13+
[follow the steps here instead](http://hexdocs.pm/tidewave/react.html).
14+
15+
This project can also be used through the CLI or as a standalone Model
16+
Context Protocol (MCP) server for your editors.
1517

1618
## Installation
1719

1820
### Next.js
1921

20-
Install it with:
22+
If you are using Next.js, install Tidewave with:
2123

2224
```sh
2325
$ npm install -D tidewave
@@ -110,8 +112,12 @@ export async function register() {
110112
}
111113
```
112114

115+
Now make sure [Tidewave is installed](https://hexdocs.pm/tidewave/installation.html) and you are ready to connect Tidewave to your app.
116+
113117
### React + Vite
114118

119+
If you are building a front-end application, using a backend as a service, such as Supabase, or a non-officially supported web framework, we recommend using our React + Vite integration.
120+
115121
Install it with:
116122

117123
```sh
@@ -135,6 +141,10 @@ export default defineConfig({
135141
});
136142
```
137143

144+
Now make sure [Tidewave is installed](https://hexdocs.pm/tidewave/installation.html) and you are ready to connect Tidewave to your app.
145+
146+
If you are using Supabase or similar, you can prompt Tidewave to use the `supabase` CLI so it has complete access to your database. For non-officially supported web frameworks, our React + Vite integration allows Tidewave Web to perform changes on the front-end, and the agent will be able to modify your backend code as usual, but some functionality (such as accessing logs, doing database calls, etc) won't be available.
147+
138148
### Configuration
139149

140150
Next.js' `tidewaveHandler` and Vite's `tidewave` accept the configuration options below:

0 commit comments

Comments
 (0)