adamotte / cwfoundation Goto Github PK

CWFoundation
============

Additions and utilities to augment the Foundation framework created by Jayway.

This project is created with the intent to be used as a sub-project for other
Xcode project. Additionaly this project can be used as a git sub module.

You add this project as a sub project in Xcode like this:
1. Add this project as a sub project to your project.
2. Make sure this project product (libCWFoundation.a) is a target member.
3. Add the CWFoundation target as direct dependency.
4. Add <Path To CWFoundation>/** to user header search paths.
5. Add -all_load to other linker flags.

The CWNetworkMonitor target containst an improved version of the Reachability
sample code, and must be linked against SystemConfiguration.framework.


Functionality
=============

The public headerfiles are the official source of documentation. This section
only describes a subset of the funcationality.

* CWLog - Conditional logging replacing NSLog.
* CWNetworkMonitor - An improved Reachability class.
* CWOrderedDictionary - For the cases where the order of the obejcts matter.
* CWTranslator - Utility for transforming an ordered input into domain objects.
  * CWXMLTranslator - A concrete subclass that translates XML into domain objects.
  * See README-Translator for more information.
* NSError - Convinience additions for creating localized errors.
* NSArray - Additions for inserting objects into sorted arrays.
* NSDate - Additoins for working with ISO and reltive dates.
* NSObject - Methods for accessing asynchronious proxies.
* NSObject - OO abstractions for run-time associated objects.
* NSOPerationQueue - Adds a default queueu, and more.
* NSURLFromDataTransformer - Store relative file URLs in Core Data.


Licence
=======

CWFoundation is open source licensed under New BSD Licence.
The intent and purpose for this licence is that you are free to use CWFoundation
for any purpose as long as you give attribution.


Copyright (c) 2011, Jayway AB, All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of Jayway AB nor the names of its contributors may 
      be used to endorse or promote products derived from this software 
      without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL JAYWAY AB BE LIABLE FOR ANY DIRECT, INDIRECT, 
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.