Update and reformat readme

_build/config.json

@@ -3,7 +3,7 @@
     "lowCaseName": "modtimetable",
     "description": "CMP enabled app to create simple weekly timetables for clubs.",
     "author": "Murray Wood",
-    "version": "0.2.0",
+    "version": "1.0.1-pl",
     "package":{
         "menus": [{
             "text": "modtimetable.menu.modtimetable"

core/components/modtimetable/docs/changelog.txt

@@ -1,5 +1,9 @@
 Changelog for modTimetable.
 
+modTimetable 1.0.1-pl
+==================
+- Fixed a bug that wouldn't allow description fields to save
+
 modTimetable 0.2.0
 ==================
 - Fixed table rendering bug where certain days were disabled.

core/components/modtimetable/docs/readme.txt

@@ -1,19 +1,19 @@
 ---------------------------------------
 modTimetable
 ---------------------------------------
-Version: 0.1.2
+Version: 1.0.1-pl
 Author: Murray Wood <[email protected]>
 ---------------------------------------
 
-For MODX Revolution 2.3+
+For MODX Revolution 2.6.5+
+
+Requires PHP 7.1+
 
-Requires PHP 5.5+
 
-Currently in Alpha. Use at own risk.
 
 A user-friendly Custom Manager Page for inputting weekly timetable data with options on how to display it on the web context.
 
-Render it in a HTML grid or straight to divs. Custom chunks available soon.
+Render it in a HTML grid or straight to divs.
 
 Example Snippet calls
 -------------
@@ -45,8 +45,6 @@ To display a single day from multiple timetables relative to the current day:
     &day=`auto`
 ]]
 
-NEW
-
-A new snippet that returns the next day name that has active sessions:
+A snippet that returns the next day name that has active sessions:
 [[!mtNextDayName]]
 

readme.md

@@ -1,45 +1,53 @@
-modTimetable
-=
-For MODX Revolution 2.3+
+#modTimetable
 
-Requires PHP 5.5+
+For MODX Revolution 2.6.5+
 
-Currently in Alpha. Use at own risk.
+Requires PHP 7.1+
 
 A user-friendly Custom Manager Page for inputting weekly timetable data with options on how to display it on the web context.
 
 Render it in a HTML grid or straight to divs. Custom chunks available soon.
 
-Example Snippet calls
--------------
+#Example Snippet calls
+
 To show timetables with IDs 1 and 2 in a table:
-[[!modTimetable? &timetables=\`1,2\` &renderTable=\`1\`]] 
 
-or to include custom chunks:
+```
 [[!modTimetable? 
-    &timetables=\`1,2\` 
-    &renderTable=\`1\` 
-    &tableHeaderRowTpl=\`myHeaderRowChunk\` 
-    &timetableTpl=\`myMainTimetableChunk\`
-    &sessionTpl=\`mySessionChunk\`
+    &timetables=`1,2` 
+    &renderTable=`1`
 ]]
+```
 
+or to include custom chunks:
+```
+[[!modTimetable? 
+    &timetables=`1,2` 
+    &renderTable=`1` 
+    &tableHeaderRowTpl=`myHeaderRowChunk` 
+    &timetableTpl=`myMainTimetableChunk`
+    &sessionTpl=`mySessionChunk`
+]]
+```
 To display sessions for a single day from multiple timetables:
 (This depends on what you set the day name as in the CMP.)
+```
 [[!modTimetable?
-    &timetables=\`1,2\`
-    &day=\`Tuesday\`
+    &timetables=`1,2`
+    &day=`Tuesday`
 ]]
-
+```
 To display a single day from multiple timetables relative to the current day:
 (This will display the next "active" day that contains sessions.)
+
+```
 [[!modTimetable?
-    &timetables=\`1,2\`
-    &day=\`auto\`
+    &timetables=`1,2`
+    &day=`auto`
 ]]
+```
 
-
-NEW
---
-A new snippet that returns the next day name that has active sessions:
-[[!mtNextDayName]]
+A snippet that returns the next day name that has active sessions:
+```
+[[!mtNextDayName]]
+```