Skip to content
Browse files

Update readme to warn for the poor state the addon is in

  • Loading branch information...
1 parent 436158a commit 48c63659599f65ba299296784f740754ed4903ab @Mark-H committed May 21, 2011
Showing with 13 additions and 23 deletions.
  1. +13 −23 README
View
36 README
@@ -1,27 +1,17 @@
-/*
- * VersionX
- *
- * Copyright 2010-2011 by Mark Hamstra (contact via www.markhamstra.nl)
- *
- * This file is part of VersionX, a basic versioning addon for MODx CMF.
- *
- * VersionX is free software; you can redistribute it and/or modify it under the
- * terms of the GNU General Public License as published by the Free Software
- * Foundation; either version 2 of the License, or (at your option) any later
- * version.
- *
- * VersionX is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along with
- * VersionX; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
- * Suite 330, Boston, MA 02111-1307 USA
- *
- */
-
+**PLEASE READ THIS!!**
+VersionX was first developed in December 2010, and I have since then learned a lot about proper addon development, however this addon does not yet meet those standards I set for my own work.
+It may seem contradictionary, but unless you are a developer I would suggest against using this addon at this point. It is *not* stable and while it may not hurt your website or installation, it simply doesn't do what it should and can make you pull out your hair.
+
+VersionX works better in 2.0.x than it does in 2.1 at this point.
+
+A full rewrite is planned for whenever I have time - there's a lot that needs to be rewritten from ground up, such as the database structure and the filesystem. This rewrite will not only increase the stability and the functionality, but will also make sure the code doesn't become as outdated as it is now.
+
+
+
+If you still want to try it out, here's some information...
+
VersionX is a basic versioning Add-on for the MODx CMF. It keeps track of changes
-to resources, and starting in VersionX 1.1, also chunks and snippets.
+to resources.
Versioning is a much requested feature which is what sparked the development of this
addon. Please check out the information linked to on the Wiki for more information

0 comments on commit 48c6365

Please sign in to comment.
Something went wrong with that request. Please try again.