From 3d7b82476899c64af5929817b3c44c03bc32520f Mon Sep 17 00:00:00 2001 From: Warrick Bayman Date: Mon, 26 Aug 2019 08:20:27 +0200 Subject: [PATCH] Small readme update. Updated documentation on the way. --- readme.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/readme.md b/readme.md index 736a33e..ca5f2d8 100644 --- a/readme.md +++ b/readme.md @@ -7,10 +7,7 @@ Timewarp is simple library for dealing with iCalendar objects. The library attempts to adhere to RFC [5545](https://tools.ietf.org/html/rfc5545) and [5546](https://tools.ietf.org/html/rfc5546). -**Timewarp requires PHP 7.0.** - -> It's still early days. I'm still working through Timewarp and there's a lot of features and requirements missing. The documentation is as I last left it and might not be up-to-date. Until version 1.0, I cannot make any promises about the quality of the documention, or Timewarp itself, for that matter. -> However, Timewarp is intended as a core component for tools I am currently working on, so it will be actively developped in the foreseeable future. +> There's a lot of features and requirements missing and I'll work on documentation as time allows. It might not be as up-to-date as it should be until a version 1.0 is complete, so I cannot make any promises as to the quality of the documentation. However I use Timewarp myself in a number of projects, so it does (and will) receive updates. --- @@ -34,8 +31,6 @@ Or update your `composer.json` file with do a `composer update`: # Usage -**Note:** Timewarp is pre-v1 and is subject to a lot of changes. I will try to keep this documentation up-to-date, but I can't promise anything until version 1. - An iCalendar object is generally composed of a number of properties and calender components. A calendar object MUST contain at least one calendar component, and will often not contain more than one, although entirely possible. Timewarp calendars can be created in one of two ways. Either create the calendar object first and add components to it, or create a calendar component and wrap it in a calendar object. You might find the later approach to be a little more semantic when working with a single component.