Jelajahi Sumber

[docs] updating documentation in more sensible way

gediminasm 13 tahun lalu
induk
melakukan
4931b7d671
2 mengubah file dengan 15 tambahan dan 17 penghapusan
  1. 2 0
      LICENSE
  2. 13 17
      README.md

+ 2 - 0
LICENSE

@@ -1,5 +1,7 @@
 Copyright (c) 2011 Gediminas Morkevičius
 Copyright (c) 2011 Gediminas Morkevičius
 
 
+The MIT license, reference http://www.opensource.org/licenses/mit-license.php
+
 Permission is hereby granted, free of charge, to any person obtaining a copy
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 in the Software without restriction, including without limitation the rights

+ 13 - 17
README.md

@@ -2,6 +2,19 @@
 
 
 **Version 2.2-DEV**
 **Version 2.2-DEV**
 
 
+### Latest updates
+
+**Note:** Use 2.1.x tag in order to use extensions based on Doctrine2.1.x versions. Currently
+master branch is based on 2.2.x versions and may not work with 2.1.x components
+
+**2011-09-24**
+
+- Sluggable was refactored with a **BC break** for the sake of simplicity it now uses a single @Slug annotation.
+Also there were slug handlers introduced for extended sluggable functionality, like path based
+or relation based slugs. See the [documentation](https://github.com/l3pp4rd/DoctrineExtensions/blob/master/doc/sluggable.md)
+
+### Summary and features
+
 This package contains extensions for Doctrine2 that hook into the facilities of Doctrine and
 This package contains extensions for Doctrine2 that hook into the facilities of Doctrine and
 offer new functionality or tools to use Doctrine2 more efficently. This package contains mostly
 offer new functionality or tools to use Doctrine2 more efficently. This package contains mostly
 used behaviors which can be easily attached to your event system of Doctrine2 and handle the
 used behaviors which can be easily attached to your event system of Doctrine2 and handle the
@@ -17,9 +30,6 @@ records being flushed in the behavioral way. List of extensions:
 Currently these extensions support **Yaml**, **Annotation**  and **Xml** mapping. Additional mapping drivers
 Currently these extensions support **Yaml**, **Annotation**  and **Xml** mapping. Additional mapping drivers
 can be easily implemented using Mapping extension to handle the additional metadata mapping.
 can be easily implemented using Mapping extension to handle the additional metadata mapping.
 
 
-**Note:** doctrine2.0.x branch is no longer being supported and all new features
-and fixes are on master branch, which currently supports 2.1.x versions of doctrine2
-
 **Note:** Please note, that xml mapping needs to be in a different namespace, the declared namespace for
 **Note:** Please note, that xml mapping needs to be in a different namespace, the declared namespace for
 Doctrine extensions is http://gediminasm.org/schemas/orm/doctrine-extensions-mapping
 Doctrine extensions is http://gediminasm.org/schemas/orm/doctrine-extensions-mapping
 So root node now looks like this:
 So root node now looks like this:
@@ -34,20 +44,6 @@ master branch is based on 2.2.x versions and may not work with 2.1.x
 </doctrine-mapping>
 </doctrine-mapping>
 ```
 ```
 
 
-### Latest updates
-
-**2011-09-23**
-
-- Refactored sluggable for doctrine2.2 by specifieng slug fields directly in slug annotation
-- Slug handler functionality, possibility to create custom ones or use built-in
-
-**2011-08-08**
-
-- Sluggable listener now has extension points to extend the default behavior of sluggable. 
-By default there is TreeSlug, RelativeSlug handlers. Which can build a tree path like slug
-example: **category/shoes/nike**. Using relative slug handler it is possible to have related slug
-for example, user is related to company by ManyToOne relation in result slug is: **company/user-name**
-
 ### ODM MongoDB support
 ### ODM MongoDB support
 
 
 List of extensions which support ODM
 List of extensions which support ODM