diff --git a/README.md b/README.md index 118f92c..d0d86c9 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,17 @@ Accepts a list of iCal URLs (without auth) and publishes to a page. Almost entirely generated with ChatGPT. I lay no claim that I have manually written this entire thing myself. I just need something working and fast. + +## MVP + +The MVP has very basic functionality. We leverage two external libraries however +have included them within the plugin: + +1. [FullCalendar](https://github.com/fullcalendar/fullcalendar) +2. [ics-parser](https://github.com/u01jmg3/ics-parser) + +We pull from a public iCal/ICS URL via the server. We then process and display +this information when a shortcode (`[event-calendar]`) is called. + +We store a list/array of URLs to pull from, so you should be able to add a +couple.