Skip to content
This repository has been archived by the owner on Dec 7, 2017. It is now read-only.

Commit

Permalink
Updating README.
Browse files Browse the repository at this point in the history
  • Loading branch information
Jan Weiß committed Oct 16, 2012
1 parent dcf3022 commit b18e7a4
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.markdown
Expand Up @@ -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.
Expand Down

0 comments on commit b18e7a4

Please sign in to comment.