Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
benjreinhart committed Jul 19, 2024
1 parent b4c3623 commit b704012
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,14 @@ Srcbooks export to markdown using the `.src.md` extension. These files can easil

To learn more, try out the interactive tutorial which is itself a Srcbook by clicking "Getting Started" when launching the application.

![the getting started srcbook](./assets/getting-started-srcbook.png)

## Note
#### ⚠️ Warning

Srcbook is currently in alpha which means there may be breaking changes until it's out of alpha.

If you upgrade and are having trouble launching the application, you can `rm -rf ~/.srcbook` to clear the Srcbook directory and start from a clean state. This will, however, delete all your Srcbooks so you may want to first export any you care about to a `.src.md` file.

![the getting started srcbook](./assets/getting-started-srcbook.png)

## Requirements

Srcbook requires node v22+. We highly recommend using [nvm](https://github.com/nvm-sh/nvm) to manage local node versions.
Expand Down

0 comments on commit b704012

Please sign in to comment.