From 742b02cf931f761b38478ef5787a4502c7ca1236 Mon Sep 17 00:00:00 2001 From: isUnknown Date: Tue, 17 Sep 2024 18:21:37 +0200 Subject: [PATCH] add dependencies to documentation --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ab10d5d..e70ca0c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,26 @@ -The project is based on [Kirby CMS](https://getkirby.com), [Vite](https://vitejs.dev/) + [Vue](https://fr.vuejs.org/) and [Pinia](https://pinia.vuejs.org/) as a state manager. -Vue is used following the composition API approach. +The project is based on + +- [Kirby CMS](https://getkirby.com) as the content management system +- [Vite](https://vitejs.dev/) as the build tool +- [Vue](https://fr.vuejs.org/) as the JavaScript framework +- [Vue Router](https://router.vuejs.org) for handling routing + [Pinia](https://pinia.vuejs.org/) as a state management library. + +Vue is used with the composition API approach. + +The project also includes some helper libraries that are available throughout the /src directory. These libraries include: + +- [dayjs](https://day.js.org/): a lightweight JavaScript date library for parsing, manipulating, and formatting dates. To use dayjs in your code, you can import it like this: + +```javascript +import dayjs from "dayjs"; +``` + +- [slugify](https://www.npmjs.com/package/slugify): a library for converting strings into URL-friendly slugs. To use slugify in your code, you can import it like this: + +```javascript +import slugify from "slugify"; +``` # Development