Skip to content

Commit e4f8554

Browse files
authored
updates readme to walk folks through using the CLI and CTA UI (#107)
1 parent 5adb494 commit e4f8554

File tree

2 files changed

+17
-4
lines changed

2 files changed

+17
-4
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ cd packages/cta-ui
7171
pnpm dev:ui
7272
```
7373

74-
At this poing you should be able to navigate to `http://localhost:3000` and see the React app connected to the API server on `http://localhost:8080`.
74+
Navigate to `http://localhost:3000` and see the React app connected to the API server on `http://localhost:8080`.
7575

7676
## Running the Monorepo in Watch Mode
7777

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,17 @@
1-
TanStack Application Builders
2-
============================
1+
# TanStack Application Builders
32

4-
This monorepo contains the code for the TanStack Application Builders. For more information on how to contribute to the project, please refer to the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
3+
This monorepo contains the code for the TanStack Application Builders.
4+
5+
# How to Use
6+
7+
In your terminal, run the following command and walk through a series of options to create a Tanstack application:
8+
9+
```bash
10+
npx create-tsrouter-app@latest
11+
```
12+
13+
Navigate to `http://localhost:8080` to see your app.
14+
15+
# How to Contribute
16+
17+
For more information on how to contribute to the project, please refer to the [CONTRIBUTING.md](./CONTRIBUTING.md) guide.

0 commit comments

Comments
 (0)