Permalink
Browse files

Update Readme for Ownership change and 0.3.0 release

  • Loading branch information...
1 parent 794e237 commit cedb7c415bcd204616cf5d4d0ea0f50cdfdf91b0 @pboling committed Nov 6, 2012
Showing with 20 additions and 14 deletions.
  1. +20 −14 README.rdoc
View
@@ -1,20 +1,21 @@
-==Notes on this fork
+== Change of Ownership and 0.3.0 Release Notes
-This fork of xing/flag_shih_tzu is in production use on http://www.neighborino.com.
-I have been maintaining a fork of the official flag_shih_tzu for several years.
-I regularly glom improvements from other forks into my fork.
-It adds a few (fully tested, fully backwards compatible) features to the official flavor (xing):
+FlagShihTzu was originally a {XING AG}[http://www.xing.com/] project. {Peter Boling}[http://peterboling.com] was a long time contributor and watcher of the project.
+In September 2012 XING transferred ownership of the project to Peter Boling. Peter Boling had been maintaining a
+fork with extended capabilities. These additional features become a part of the 0.3 line. The 0.2 line of the gem will
+remain true to XING's original. The 0.3 line aims to maintain complete parity and compatibility with XING's original as
+well. I will continue to monitor other forks for original ideas and improvements. Pull requests are welcome, but please
+rebase your work onto the current master to make integration easier.
+
+Some new things in the 0.3 line:
* ClassWithHasFlags.set_#{flag_name}_sql # Returns the sql string for setting a flag for use in customized SQL
* ClassWithHasFlags.unset_#{flag_name}_sql # Returns the sql string for unsetting a flag for use in customized SQL
* ClassWithHasFlags.flag_columns # Returns the column_names used by FlagShihTzu as bit fields
* has_flags :strict => true # DuplicateFlagColumnException raised when a single DB column is declared as a flag column twice
* Less verbosity for expected conditions when the DB connection for the class is unavailable.
-* Tests for additional features, but does not change any behavior of official version by default.
-* Easily migrate from official version. No code changes required.
-
-I would welcome any of these additions/improvements being added to the official version.
-I recognize a feature branch per feature added would be best, but my fork is so old that I'm not sure how to accomplish that.
+* Tests for additional features, but does not change any behavior of 0.2 versions by default.
+* Easily migrate from 0.2 versions. No code changes required.
=FlagShihTzu
@@ -46,7 +47,7 @@ http://en.wikipedia.org/wiki/Shih_Tzu
==Build status
-{<img src="https://secure.travis-ci.org/xing/flag_shih_tzu.png" />}[http://travis-ci.org/xing/flag_shih_tzu]
+{<img src="https://secure.travis-ci.org/pboling/flag_shih_tzu.png" />}[http://travis-ci.org/pboling/flag_shih_tzu]
==Prerequisites
@@ -188,7 +189,7 @@ on Spaceship:
Spaceship.flag_columns # [:features, :crew]
-Opionally, you can set the <tt>:bang_methods</tt> option to true to enable the bang methods:
+Optionally, you can set the <tt>:bang_methods</tt> option to true to enable the bang methods:
Spaceship#electrolytes!
Spaceship#not_electrolytes!
@@ -315,22 +316,27 @@ specify which config from <tt>test/database.yml</tt> to use, e.g.:
==Authors
+{Peter Boling}[http://github.com/pboling],
{Patryk Peszko}[http://github.com/ppeszko],
{Sebastian Roebke}[http://github.com/boosty],
{David Anderson}[http://github.com/alpinegizmo],
{Tim Payton}[http://github.com/dizzy42]
and a helpful group of
-{contributors}[https://github.com/xing/flag_shih_tzu/contributors].
+{contributors}[https://github.com/pboling/flag_shih_tzu/contributors].
Thanks!
-Please find out more about our work in our
+Find out more about Peter Boling's work
+{PeterBoling.com}[http://peterboling.com/].
+
+Find out more about XING
{Devblog}[http://devblog.xing.com/].
==License
The MIT License
+Copyright (c) 2012 {Peter Boling}[http://www.peterboling.com/]
Copyright (c) 2011 {XING AG}[http://www.xing.com/]
Permission is hereby granted, free of charge, to any person obtaining a copy

0 comments on commit cedb7c4

Please sign in to comment.