From 584535808b39b871cc87f808fbfd93bc55ddc61c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alvaro=20Trigo=20Lo=CC=81pez?= Date: Sun, 19 Jan 2025 18:05:54 +0100 Subject: [PATCH] - Documentation: improved docs for example --- example/README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/example/README.md b/example/README.md index 0c622b8..08c22a8 100644 --- a/example/README.md +++ b/example/README.md @@ -1,9 +1,20 @@ ## Running the example -From the example folder: +This example demonstrates how to use fullPage.js with Vue.js. To learn how to use fullPage.js effectively, developers should refer to the relevant documentation: + +- [fullPage.js Documentation for Vue](https://github.com/alvarotrigo/vue-fullpage.js?tab=readme-ov-file#vue-fullpagejs---official-vuejs-3-wrapper) +- [fullPage.js Core / API Documentation](https://alvarotrigo.com/fullPage/docs/) +- [fullPage.js Examples](https://alvarotrigo.com/fullPage/examples/) +- [fullPage.js Extensions](https://alvarotrigo.com/fullPage/extensions/) + +## Serving the Example + +In order to run and serve the example, run the following command from this same folder `/examples/`: ```sh npm i npm start # go to localhost:3000 ``` + +Now you'll be able to access the example at: http://localhost:3000 \ No newline at end of file