From 495e3579ff51b979d727479511d59cbe50fbbf0a Mon Sep 17 00:00:00 2001 From: Javier Chavarri Date: Thu, 5 Oct 2023 15:40:58 +0000 Subject: [PATCH] update readmes --- README.md | 14 +++++++------- examples/2-react/README.md | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8746a53..0980c22 100644 --- a/README.md +++ b/README.md @@ -12,15 +12,15 @@ If you are looking for a template with esy, check Each example is a self-contained, complete project with its README, a Makefile and an opam file to define the dependencies. -To use any of the examples, clone this repository, and then just replace the -contents with the folder of the example you want to use to get started. +To use any of the examples, you can copy/paste the example folder in a new +project and start hacking on it. -Then follow the example `README.md` instructions to get started. +Each example includes a `README.md` with instructions on how to get started. -- [**`1-node`**](examples/1-node)  —  a simple Node.js application, - prints a "hello world" message when it runs. -- [**`2-react`**](examples/2-react)  —  a simple Reason React app with - Webpack. +- [**`1-node`**](examples/1-node)  —  a simple Node.js + application, prints a "hello world" message when it runs. +- [**`2-react`**](examples/2-react)  —  a simple Reason React + app with Webpack. ## Contributing diff --git a/examples/2-react/README.md b/examples/2-react/README.md index 07e21f1..0788d75 100644 --- a/examples/2-react/README.md +++ b/examples/2-react/README.md @@ -34,4 +34,4 @@ JavaScript dependencies - `make watch`: watch for the filesystem and have Melange rebuild on every change - `make serve`: serve the application with a local HTTP server - +- `make bundle`: creates a full bundle with the generated `js` files and `html` page