fixup more readmes

rsalmaso · Dec 13, 2022 · 4cf4f54 · 4cf4f54
1 parent dd5d429
commit 4cf4f54
Show file tree

Hide file tree

Showing 16 changed files with 38 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ Full-sized drag & drop calendar in JavaScript
 - [Documentation](https://fullcalendar.io/docs)
 - [Changelog](CHANGELOG.md)
 - [Support](https://fullcalendar.io/support)
-- [License](LICENSE.txt)
+- [License](LICENSE.md)
 - [Contributing](CONTRIBUTING.md)
 - [Roadmap](https://fullcalendar.io/roadmap)
 

diff --git a/packages/bootstrap4/README.md b/packages/bootstrap4/README.md
@@ -7,7 +7,7 @@
 
 ## Installation
 
-First, ensure you have the necessary Bootstrap packages installed:
+First, ensure the necessary Bootstrap packages are installed:
 
 ```sh
 npm install bootstrap@4 @fortawesome/fontawesome-free
@@ -28,7 +28,7 @@ import { Calendar } from '@fullcalendar/core'
 import bootstrapPlugin from '@fullcalendar/bootstrap'
 import dayGridPlugin from '@fullcalendar/daygrid'
 
-// import the third-party stylesheets directly from your JS
+// import third-party stylesheets directly from your JS
 import 'bootstrap/dist/css/bootstrap.css'
 import '@fortawesome/fontawesome-free/css/all.css' // needs additional webpack config!
 

diff --git a/packages/bootstrap4/package.json b/packages/bootstrap4/package.json
@@ -2,7 +2,7 @@
   "name": "@fullcalendar/bootstrap",
   "version": "6.0.0-beta.4",
   "title": "FullCalendar Bootstrap 4 Plugin",
-  "description": "Bootstrap 4 theme for your calendar",
+  "description": "Bootstrap 4 theme for FullCalendar",
   "keywords": [
     "bootstrap",
     "bootstrap4"

diff --git a/packages/bootstrap5/README.md b/packages/bootstrap5/README.md
@@ -5,7 +5,7 @@
 
 ## Installation
 
-First, ensure you have the necessary Bootstrap packages installed:
+First, ensure the necessary Bootstrap packages are installed:
 
 ```sh
 npm install bootstrap@5 bootstrap-icons

diff --git a/packages/icalendar/README.md b/packages/icalendar/README.md
@@ -5,7 +5,13 @@ Display events from a public [iCalendar feed](https://icalendar.org/)
 
 ## Installation
 
-Install the FullCalendar core package, the iCalendar plugin, and any other plugins (like [daygrid](https://fullcalendar.io/docs/month-view)):
+First, ensure ical.js is installed:
+
+```sh
+npm install ical.js
+```
+
+Then, install the FullCalendar core package, the iCalendar plugin, and any other plugins (like [daygrid](https://fullcalendar.io/docs/month-view)):
 
 ```sh
 npm install @fullcalendar/core @fullcalendar/icalendar @fullcalendar/daygrid

diff --git a/packages/icalendar/package.json b/packages/icalendar/package.json
@@ -8,15 +8,14 @@
     "ics"
   ],
   "homepage": "https://fullcalendar.io/docs/icalendar",
-  "dependencies": {
-    "ical.js": "^1.4.0"
-  },
   "peerDependencies": {
-    "@fullcalendar/core": "workspace:*"
+    "@fullcalendar/core": "workspace:*",
+    "ical.js": "^1.4.0"
   },
   "devDependencies": {
     "@fullcalendar/core": "workspace:*",
-    "@fullcalendar/standard-scripts": "workspace:*"
+    "@fullcalendar/standard-scripts": "workspace:*",
+    "ical.js": "^1.4.0"
   },
   "scripts": {
     "build": "standard-scripts pkg:build",

diff --git a/packages/luxon1/README.md b/packages/luxon1/README.md
@@ -1,11 +1,11 @@
 
 # FullCalendar Luxon 1 Plugin
 
-Enhanced date formatting, conversion, and time zone functionality with [Luxon](https://moment.github.io/luxon/) 1
+Enhanced date formatting, conversion, and [named time zone](https://fullcalendar.io/docs/timeZone#named-time-zones) functionality with [Luxon](https://moment.github.io/luxon/) 1
 
 ## Installation
 
-First, ensure you have the Luxon installed:
+First, ensure Luxon is installed:
 
 ```sh
 npm install luxon@1

diff --git a/packages/luxon1/package.json b/packages/luxon1/package.json
@@ -2,7 +2,7 @@
   "name": "@fullcalendar/luxon",
   "version": "6.0.0-beta.4",
   "title": "FullCalendar Luxon 1 Plugin",
-  "description": "Enhanced date formatting, conversion, and time zone functionality with Luxon 1",
+  "description": "Enhanced date formatting, conversion, and named time zone functionality with Luxon 1",
   "keywords": [
     "luxon",
     "luxon1",

diff --git a/packages/luxon2/README.md b/packages/luxon2/README.md
@@ -1,11 +1,11 @@
 
 # FullCalendar Luxon 2 Plugin
 
-Enhanced date formatting, conversion, and time zone functionality with [Luxon](https://moment.github.io/luxon/) 2
+Enhanced date formatting, conversion, and [named time zone](https://fullcalendar.io/docs/timeZone#named-time-zones) functionality with [Luxon](https://moment.github.io/luxon/) 2
 
 ## Installation
 
-First, ensure you have the Luxon installed:
+First, ensure Luxon is installed:
 
 ```sh
 npm install luxon@2

diff --git a/packages/luxon2/package.json b/packages/luxon2/package.json
@@ -2,7 +2,7 @@
   "name": "@fullcalendar/luxon2",
   "version": "6.0.0-beta.4",
   "title": "FullCalendar Luxon 2 Plugin",
-  "description": "Enhanced date formatting, conversion, and time zone functionality with Luxon 2",
+  "description": "Enhanced date formatting, conversion, and named time zone functionality with Luxon 2",
   "keywords": [
     "luxon",
     "luxon2",

diff --git a/packages/moment-timezone/README.md b/packages/moment-timezone/README.md
@@ -1,17 +1,17 @@
 
 # FullCalendar Moment Timezone Plugin
 
-Enhanced named time zone functionality with [Moment Timezone](https://momentjs.com/timezone/)
+Enhanced [named time zone](https://fullcalendar.io/docs/timeZone#named-time-zones) functionality with [Moment Timezone](https://momentjs.com/timezone/)
 
 ## Installation
 
-First, ensure you have the Moment Timezone installed:
+First, ensure Moment Timezone is installed:
 
 ```sh
 npm install moment-timezone
 ```
 
-Then, install the FullCalendar core package, the Moment plugin, and any other plugins (like [daygrid](https://fullcalendar.io/docs/month-view)):
+Then, install the FullCalendar core package, the Moment Timezone plugin, and any other plugins (like [daygrid](https://fullcalendar.io/docs/month-view)):
 
 ```sh
 npm install @fullcalendar/core @fullcalendar/moment-timezone @fullcalendar/daygrid

diff --git a/packages/moment/README.md b/packages/moment/README.md
@@ -5,7 +5,7 @@ Enhanced date formatting and conversion with [Moment](https://momentjs.com/)
 
 ## Installation
 
-First, ensure you have the Moment installed:
+First, ensure Moment is installed:
 
 ```sh
 npm install moment
@@ -23,7 +23,7 @@ Instantiate a Calendar with the necessary plugin:
 
 ```js
 import { Calendar } from '@fullcalendar/core'
-import momentPlugin from '@fullcalendar/luxon'
+import momentPlugin from '@fullcalendar/moment'
 import dayGridPlugin from '@fullcalendar/daygrid'
 
 const calendarEl = document.getElementById('calendar')

diff --git a/packages/rrule/README.md b/packages/rrule/README.md
@@ -5,7 +5,13 @@ Recurring events with [RRule](https://github.com/jakubroztocil/rrule)
 
 ## Installation
 
-Install the FullCalendar core package, the RRule plugin, and any other plugins (like [daygrid](https://fullcalendar.io/docs/month-view)):
+First, ensure the RRule lib is installed:
+
+```sh
+npm install rrule
+```
+
+Then, install the FullCalendar core package, the RRule plugin, and any other plugins (like [daygrid](https://fullcalendar.io/docs/month-view)):
 
 ```sh
 npm install @fullcalendar/core @fullcalendar/rrule @fullcalendar/daygrid

diff --git a/packages/timegrid/README.md b/packages/timegrid/README.md
@@ -1,7 +1,7 @@
 
 # FullCalendar Time Grid Plugin
 
-Display events on a view with time slots
+Display events on time slots
 
 ## Installation
 

diff --git a/packages/timegrid/package.json b/packages/timegrid/package.json
@@ -2,7 +2,7 @@
   "name": "@fullcalendar/timegrid",
   "version": "6.0.0-beta.4",
   "title": "FullCalendar Time Grid Plugin",
-  "description": "Display events on a view with time slots",
+  "description": "Display events on time slots",
   "keywords": [
     "time",
     "slots"

diff --git a/packages/web-component/README.md b/packages/web-component/README.md
@@ -1,8 +1,7 @@
 
 # FullCalendar Web Component
 
-This package provides a FullCalendar [Web Component](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) (aka "Custom Element") that accepts a single
-`options` attribute. It must be a valid JSON string.
+This package provides a FullCalendar [Web Component](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) (aka "Custom Element") that accepts a single `options` attribute. It must be a valid JSON string.
 
 ```html
 <!DOCTYPE html>
@@ -27,8 +26,7 @@ This package provides a FullCalendar [Web Component](https://developer.mozilla.o
 </html>
 ```
 
-It is also possible to set an `options` *property* on the DOM element. This property is a rich
-JavaScript object, not merely a JSON string.
+It is also possible to set an `options` *property* on the DOM element. This property is a real JavaScript object, not merely a JSON string.
 
 ```js
 const fullCalendarElement = document.querySelector('full-calendar')