aboutsummaryrefslogtreecommitdiffstats
path: root/library/fullcalendar/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'library/fullcalendar/README.md')
-rw-r--r--library/fullcalendar/README.md77
1 files changed, 69 insertions, 8 deletions
diff --git a/library/fullcalendar/README.md b/library/fullcalendar/README.md
index 991011fc5..8c9540922 100644
--- a/library/fullcalendar/README.md
+++ b/library/fullcalendar/README.md
@@ -1,13 +1,74 @@
-# FullCalendar [![Build Status](https://travis-ci.com/fullcalendar/fullcalendar.svg?branch=master)](https://travis-ci.com/fullcalendar/fullcalendar)
+# FullCalendar
-A full-sized drag & drop JavaScript event calendar
+Full-sized drag & drop calendar in JavaScript
-- [Project website and demos](http://fullcalendar.io/)
-- [Documentation](http://fullcalendar.io/docs)
-- [Support](http://fullcalendar.io/support)
-- [Contributing](CONTRIBUTING.md)
+- [Project Website](https://fullcalendar.io/)
+- [Documentation](https://fullcalendar.io/docs)
- [Changelog](CHANGELOG.md)
-- [License](LICENSE.txt)
+- [Support](https://fullcalendar.io/support)
+- [License](LICENSE.md)
+- [Roadmap](https://fullcalendar.io/roadmap)
-*From the blog*: [Changes in the Upcoming v5](https://fullcalendar.io/blog/2020/02/changes-in-the-upcoming-v5)
+Connectors:
+
+- [React](https://github.com/fullcalendar/fullcalendar-react)
+- [Angular](https://github.com/fullcalendar/fullcalendar-angular)
+- [Vue 3](https://github.com/fullcalendar/fullcalendar-vue) |
+ [2](https://github.com/fullcalendar/fullcalendar-vue2)
+
+## Bundle
+
+The [FullCalendar Standard Bundle](bundle) is easier to install than individual plugins, though filesize will be larger. It works well with a CDN.
+
+## Installation
+
+Install the FullCalendar core package and any plugins you plan to use:
+
+```sh
+npm install @fullcalendar/core @fullcalendar/interaction @fullcalendar/daygrid
+```
+
+## Usage
+
+Instantiate a Calendar with plugins and options:
+
+```js
+import { Calendar } from '@fullcalendar/core'
+import interactionPlugin from '@fullcalendar/interaction'
+import dayGridPlugin from '@fullcalendar/daygrid'
+
+const calendarEl = document.getElementById('calendar')
+const calendar = new Calendar(calendarEl, {
+ plugins: [
+ interactionPlugin,
+ dayGridPlugin
+ ],
+ initialView: 'timeGridWeek',
+ editable: true,
+ events: [
+ { title: 'Meeting', start: new Date() }
+ ]
+})
+
+calendar.render()
+```
+
+## Development
+
+You must install this repo with [PNPM](https://pnpm.io/):
+
+```
+pnpm install
+```
+
+Available scripts (via `pnpm run <script>`):
+
+- `build` - build production-ready dist files
+- `dev` - build & watch development dist files
+- `test` - test headlessly
+- `test:dev` - test interactively
+- `lint`
+- `clean`
+
+[Info about contributing code &raquo;](CONTRIBUTING.md)