diff --git a/README.md b/README.md index 2018e30..5d60f8e 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,29 @@ # Vite ReScript Template -## Getting started +## Use this template + +click on "Use this template" or use npx :) ```shell +# create with clone project npx degit rescriptbr/vite-rescript-starter my-app +# enter in app folder cd my-app +# install dependency npm install ``` -or simply click on "Use this template" :) +### Development + +To development is require compile rescript + run vite: + +```shell +# compile rescript with watch mode +npm run res:dev + +# open new tab +# run vite dev +npm run dev +```