From b18e7a425afe1d447f5e309f4f2985c177569006 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Wei=C3=9F?= Date: Tue, 16 Oct 2012 17:16:00 +0200 Subject: [PATCH] Updating README. --- README.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index b2ba792..cbaa1a5 100644 --- a/README.markdown +++ b/README.markdown @@ -3,12 +3,14 @@ MagicKit.framework `MagicKit.framework` is an easy-to-use wrapper around the [`libmagic`](http://www.darwinsys.com/file/) file identification library. It provides a high-level Objective-C interface and deals in Foundation types (NSString, NSData, et al). -`MagicKit.framework` is available for both OS X (as a framework) or iOS as a static library and header files. `MagicKit.framework` consists of a master class, `GEMagicKit`, and an intermediary class, `GEMagicResult`. The `GEMagicKit` master class has four class methods, listed below in descending order of convenience. +`MagicKit.framework` is available for both OS X (as a framework) or iOS as a static library with header files. `MagicKit.framework` consists of a master class, `GEMagicKit`, and an intermediary class, `GEMagicResult`. The `GEMagicKit` master class has six class methods, listed below in descending order of convenience. + (GEMagicResult *)magicForFileAtPath:(NSString *)path; + + (GEMagicResult *)magicForFileAtURL:(NSURL *)aURL; + (GEMagicResult *)magicForData:(NSData *)data; + (GEMagicResult *)magicForFileAtPath:(NSString *)path decompress:(BOOL)decompress; + + (GEMagicResult *)magicForFileAtURL:(NSURL *)aURL decompress:(BOOL)decompress; + (GEMagicResult *)magicForData:(NSData *)data decompress:(BOOL)decompress; These methods all return the `GEMagicResult` intermediary class. The `GEMagicResult` class has four properties. These are `mimeType`, `description`, `uniformType` and `uniformTypeHierarchy`. the first three properties are `NSString` objects, the final returns an `NSArray` object.