Skip to content

Commit

Permalink
- Documentation: improved docs for example
Browse files Browse the repository at this point in the history
  • Loading branch information
alvarotrigo committed Jan 19, 2025
1 parent 46fa2ee commit 5845358
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion example/README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 5845358

Please sign in to comment.