From 39a61a1fefa8f8c52d541c42e96933af97b287c2 Mon Sep 17 00:00:00 2001 From: Anton Tranelis <31516529+antontranelis@users.noreply.github.com> Date: Fri, 21 Mar 2025 19:49:30 +0000 Subject: [PATCH] Update examples/README.md Co-authored-by: mahula --- examples/README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/examples/README.md b/examples/README.md index 6de838de..43eb75f0 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,6 +1,25 @@ # Examples +Here is a collection of executable examples. Building on each other, they show the features available in the Utipia-ui library. +You can run them and try them out locally in the browser. -This examples depend on the `/dist` of the root project. You have to run `npm run build` in the root project before you can run the examples. +## Running the examples + +These examples depend on the `/dist` of the root project. You have to run `npm run build` in the root project before you can run the examples: + +Using the example [3 - Tags](./3-tags): + +```sh +# in root directory install and build the library +npm install +npm run build + +# change to specific example directory +cd ./examples/3-tags + +# install and run the example code +npm install && npm run dev + +# call up the running example in the browser at http://localhost:5173/ ## Roadmap