Skip to content

Commit

Permalink
Update README.md (#176)
Browse files Browse the repository at this point in the history
  • Loading branch information
tatethurston authored Nov 3, 2023
1 parent 7cfc0b1 commit cd78d41
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,16 @@

![nextjs-routes preview gif](./images/nextjs-routes.gif)

## Notice

If you are using Next.js 13 or higher with the App Router, you may want to consider using static typed links. At the time of writing this is experimental:

https://nextjs.org/docs/app/building-your-application/configuring/typescript#statically-typed-links

## What is this? 🧐

`nextjs-routes` makes Next.js's `next/link` and `next/router` routes type safe with zero runtime overhead. `nextjs-routes` scans your `pages` directory and generates route types based on your application's routes.

`nextjs-routes` drops into your existing Next.js application with minimal configuration. You won't have to change any code, unless it finds some broken links!

## Notice

If you are using Next.js's App Router, Next provides an [experimental option to generate typed links](https://nextjs.org/docs/app/building-your-application/configuring/typescript#statically-typed-links). Note that at this time, Next's option only works for the `app` directory, and not `pages`.

## Highlights

🦄 Zero config
Expand Down

0 comments on commit cd78d41

Please sign in to comment.