diff --git a/README.md b/README.md index 76ea958..95526e0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,15 @@ -# Site public du club réseau +# Calendar of all calendars: Metis -[![Build Status](https://drone.rz.ens.wtf/api/badges/Klub-RZ/homepage/status.svg)](https://drone.rz.ens.wtf/Klub-RZ/homepage) +This is a meta-calendar where you can declare multiple calendars and aggregate them from multiple trusted sources. +[![Build Status](https://drone.rz.ens.wtf/api/badges/Klub-RZ/metis/status.svg)](https://drone.rz.ens.wtf/Klub-RZ/metis) + +## Instructions + +This project has only a frontend and use reverse proxies to handle multiple calendar sources and avoid CORS issues, only `npm` or similar is required, then run `npm run dev` to run the development server. + +**Warning** : You have to run `npm start` once first. + +## Deployment + +You only need to run `npm run build` to produce a production bundle you can serve statically, but, do not forget reverse proxies rules, take for example: .