Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 33 lines (23 sloc) 2.334 kb
b296df5 @jspahrsummers Adding a real README
jspahrsummers authored
1 Proton is a utility framework for Cocoa and Cocoa Touch that provides tools useful for building a powerful model layer.
2
3 # Features
4
5 - A simple and extensible system for bindings, suitable for use on iOS and for replacing Cocoa Bindings on OS X
6 - Components to make Core Data easier to use, including:
7 - `PROCoreDataManager`, to manage all the resources associated with a single database
8 - Support for copying managed objects between contexts
9 - Support for encoding and decoding managed objects to and from property lists
10 - Convenience methods on `NSManagedObject` and `NSManagedObjectContext` so callers have to write less code
11 - A class for key-value observing that makes it easier to manage the observation of many different objects or key paths
12 - A couple macros to check key paths at compile time (i.e., fail to build when an invalid key path is used)
babe25e @jspahrsummers Note the higher-order function and NSUndoManager extensions in the READM...
jspahrsummers authored
13 - Higher-order functions (map, filter, fold) for _all_ built-in collection classes
14 - Extensions to `NSUndoManager` to support blocks and make it simpler to manage undo groupings
15 - `PROFuture`, an extremely fast and simple implementation of block-based futures
b296df5 @jspahrsummers Adding a real README
jspahrsummers authored
16
17 All of the above features are unit tested, to validate the typical use cases and detect any future breakage.
18
19 Proton has been built with the [Model-View-ViewModel](http://en.wikipedia.org/wiki/Model_View_ViewModel) architectural pattern in mind. The `PROViewModel` abstract class can serve as a base for any application-specific view model layer.
20
21 # Dependencies
22
23 All dependencies can be retrieved by running `git submodule update --init --recursive` from the top level of the repository.
24
25 - Xcode projects in the repository are configured using prebuilt [xcconfigs](http://github.com/jspahrsummers/xcconfigs)
26 - The unit tests for Proton are written using [Specta](http://github.com/bitswift/specta) and [Expecta](http://github.com/bitswift/expecta)
27 - Logging is implemented using the [CocoaLumberjack](http://github.com/bitswift/CocoaLumberjack) logging framework
28 - Parts of [libextobjc](http://github.com/jspahrsummers/libextobjc) and [SafeDispatch](http://github.com/jspahrsummers/SafeDispatch) are used in Proton (but are already present in the repository)
29
30 # License
31
6457a96 @jspahrsummers Remove the BSD license clause that requires binary attribution
jspahrsummers authored
32 Proton is released under a modified version of the 3-clause BSD license. See the LICENSE file for more information.
Something went wrong with that request. Please try again.