Skip to content

Commit

Permalink
small addition to docs about cli
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanniser committed Mar 13, 2023
1 parent 1531d56 commit 65f090b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .changeset/spicy-berries-film.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"next-typesafe-url": patch
---

docs: clarify cli breakpoint and how to fix
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@ Add `next-typesafe-url` to your dev and build script in package.json.

**Note:** Using the dev script like this causes the `next-typesafe-url` script to run after the `next dev` script, which will hide any output/errors that occur during the build. If you run into issues, you can run `next-typesafe-url` in a separate terminal window to see its output.

### IMPORTANT NOTE

The cli is probably the most likely part to *slightly* break. If you run into issues just run a quick `npx next-typesafe-url` and it should generate the types. If the functions still show type errors, you can restart typescript server, but I have found a quick `crtl+click` to go the origin type file can wake the ts server up much faster.

# Usage

## Route
Expand Down

0 comments on commit 65f090b

Please sign in to comment.