Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bodhish committed Apr 12, 2021
1 parent 6547f9c commit f4800f7
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "create-reason-react-tailwind",
"version": "0.8.0",
"version": "0.8.1",
"description": "A reason react starter with tailwind and webpack",
"scripts": {
"start": "node index.js"
Expand Down
6 changes: 2 additions & 4 deletions templates/rescript-webpack/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# RE-Tailwind
# Rescript-Tailwind

## Run Project

Expand All @@ -9,14 +9,12 @@ npm start
npm run webpack
```

After you see the webpack compilation succeed (the `npm run webpack` step), open up `build/index.html` (**no server needed!**). Then modify whichever `.re` file in `src` and refresh the page to see the changes.
After you see the webpack compilation succeed (the `npm run webpack` step), open up `build/index.html` (**no server needed!**). Then modify whichever `.res` file in `src` and refresh the page to see the changes.

## Run Project with Server

To run with the webpack development server run `npm run server` and view in the browser at http://localhost:8000. Running in this environment provides hot reloading and support for routing; just edit and save the file and the browser will automatically refresh.

Note that any hot reload on a route will fall back to the root (`/`), so `ReasonReact.Router.dangerouslyGetInitialUrl` will likely be needed alongside the `ReasonReact.Router.watchUrl` logic to handle routing correctly on hot reload refreshes or simply opening the app at a URL that is not the root.

To use a port other than 8000 set the `PORT` environment variable (`PORT=8080 npm run server`)

## gitignore
Expand Down

0 comments on commit f4800f7

Please sign in to comment.