Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

[CHANGE] Change to MIT License. Update docs to README.markdown.

  • Loading branch information...
commit 54908dd0762dffbd7a3c65bb1f352f65338f09f5 1 parent 6c0106b
@rentzsch authored
View
13 About BDAlias+wolf.rtf
@@ -1,13 +0,0 @@
-{\rtf1\mac\ansicpg10000\cocoartf824\cocoasubrtf420
-{\fonttbl\f0\fswiss\fcharset77 Helvetica-Bold;\f1\fswiss\fcharset77 Helvetica;}
-{\colortbl;\red255\green255\blue255;}
-\vieww9000\viewh9000\viewkind0
-\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\ql\qnatural
-
-\f0\b\fs24 \cf0 What is BDAlias+wolf?
-\f1\b0 \
-It's just Chris Hanson's BDAlias package with two tweaks: support for the NSCoding protocol (so it's easy to persist aliases using Cocoa serialization) and addition of methods that return NSError objects.\
-\
-The unadulterated original is here:\
-{\field{\*\fldinst{HYPERLINK "http://eschatologist.net/bDistributed.com/index.html#BDAlias"}}{\fldrslt Eschatologist.net: bDistributed.com}}\
-}
View
59 About BDAlias.rtf
@@ -1,59 +0,0 @@
-{\rtf1\mac\ansicpg10000\cocoartf102
-{\fonttbl\f0\fswiss\fcharset77 Helvetica;\f1\fswiss\fcharset77 Helvetica-Bold;\f2\fswiss\fcharset77 Helvetica-Oblique;
-}
-{\colortbl;\red255\green255\blue255;\red255\green0\blue0;}
-\vieww9000\viewh9000\viewkind0
-\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\ql\qnatural
-
-\f0\fs24 \cf0
-\f1\b\fs28 \cf2 b\cf0 Distributed.com, Inc.
-\f0\b0\fs24 \
-
-\fs20 2549 W. Golf Rd. #348\
- Hoffman Estates, IL 60194\
- Phone: (847) 372-3955\
- Fax: (847) 589-3738\
- Web: bdistributed.com\
- Email: info@bdistributed.com\
-
-\fs24 \
-
-\f1\b What is BDAlias?
-\f0\b0 \
-BDAlias is a simple Cocoa class for dealing with alias records, a form of persistent file reference that is more robust and provides a better user experience than a textual path. Macintosh applications should always use alias records for persistent file references, and often for exchanging references to files with other applications.\
-\
-
-\f1\b How do I use BDAlias?
-\f0\b0 \
-"You've got the source."\
-\
-Seriously though, you create an instance of BDAlias using one of the \ul aliasWithXXX:\ulnone messages whenever you need to keep a persistent reference to a file around. If you're interacting with the rest of Cocoa, you'll probably use either \ul aliasWithPath:\ulnone or \ul aliasWithPath:relativeToPath:\ulnone When you're ready to "resolve" this reference to actually access a file, just send it a \ul fullPath\ulnone or \ul fullPathRelativeToPath:\ulnone message.\
-\
-Since the whole point of aliases is to
-\f2\i persistently
-\f0\i0 reference a file, you can easily convert an alias to an NSData object. Sending a BDAlias the \ul aliasData\ulnone message will return an autoreleased instance of NSData containing the record data ready to store wherever you can store an NSData.\
-\
-
-\f1\b Who is bDistributed.com?
-\f0\b0 \
-bDistributed.com is a Chicago-based consulting firm that specializes in WebObjects and Mac OS X development. If you'd like to discuss a project with bDistributed.com, email a brief overview of your project and contact information to sales@bdistributed.com.\
-\
-
-\f1\b License Agreement\
-
-\f0\b0 By using or downloading this software, you agree to be bound by the following license. If you do not agree to be bound by the license, please destroy all copies of this software.\
-\
-Copyright \'a9 2001-2002, bDistributed.com, Inc.\
-All rights reserved.\
-\
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:\
-\
-\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\li580\fi-580\ql\qnatural
-\cf0 * 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 bDistributed.com, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. \
-\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\ql\qnatural
-\cf0 \
-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 THE REGENTS OR CONTRIBUTORS 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. }
View
42 BDAlias.h
@@ -1,46 +1,16 @@
-/*
- Copyright (c) 2001-2002, bDistributed.com, Inc.
- All rights reserved.
+/*******************************************************************************
+ BDAlias.h
+ Copyright (c) 2001-2009 bDistributed.com, Inc.
+ Some rights reserved: <http://opensource.org/licenses/mit-license.php>
- 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 bDistributed.com, Inc. 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 THE REGENTS OR CONTRIBUTORS 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.
-*/
+ ***************************************************************************/
#import <Foundation/Foundation.h>
#import <CoreServices/CoreServices.h>
@interface BDAlias : NSObject
{
- AliasHandle _alias;
+ AliasHandle _alias;
}
- (id)initWithAliasHandle:(AliasHandle)alias; // designated initializer
View
50 BDAlias.m
@@ -1,39 +1,9 @@
-/*
- Copyright (c) 2001-2002, bDistributed.com, Inc.
- 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 bDistributed.com, Inc. 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 THE REGENTS OR CONTRIBUTORS 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.
-*/
+/*******************************************************************************
+ BDAlias.m
+ Copyright (c) 2001-2009 bDistributed.com, Inc.
+ Some rights reserved: <http://opensource.org/licenses/mit-license.php>
+
+ ***************************************************************************/
#include <assert.h>
@@ -161,7 +131,7 @@ - (id)initWithPath:(NSString *)fullPath error:(NSError **)outError
anErr = PathToFSRef((CFStringRef) fullPath, &ref);
if (anErr != noErr) {
- if (outError) *outError = [NSError errorWithDomain:NSOSStatusErrorDomain code:anErr userInfo:nil];
+ if (outError) *outError = [NSError errorWithDomain:NSOSStatusErrorDomain code:anErr userInfo:nil];
return nil;
}
@@ -212,7 +182,7 @@ - (id)initWithFSRef:(FSRef *)ref relativeToFSRef:(FSRef *)relRef error:(NSError
anErr = FSNewAlias(relRef, ref, &alias);
if (anErr != noErr) {
- if (outError) *outError = [NSError errorWithDomain:NSOSStatusErrorDomain code:anErr userInfo:nil];
+ if (outError) *outError = [NSError errorWithDomain:NSOSStatusErrorDomain code:anErr userInfo:nil];
return nil;
}
@@ -221,12 +191,12 @@ - (id)initWithFSRef:(FSRef *)ref relativeToFSRef:(FSRef *)relRef error:(NSError
- (id)initWithCoder:(NSCoder *)coder
{
- return [self initWithData:[coder decodeDataObject]];
+ return [self initWithData:[coder decodeDataObject]];
}
- (void)encodeWithCoder:(NSCoder*)coder
{
- [coder encodeDataObject:[self aliasData]];
+ [coder encodeDataObject:[self aliasData]];
}
- (void)dealloc
View
127 BDAlias.rtf
@@ -1,26 +1,14 @@
-{\rtf1\mac\ansicpg10000\cocoartf102
-{\fonttbl\f0\fswiss\fcharset77 Helvetica;\f1\fswiss\fcharset77 Helvetica-Bold;}
-{\colortbl;\red255\green255\blue255;\red255\green0\blue0;}
-\margl1440\margr1440\vieww9000\viewh9000\viewkind0
+{\rtf1\ansi\ansicpg1252\cocoartf949\cocoasubrtf430
+{\fonttbl\f0\fswiss\fcharset0 Helvetica;}
+{\colortbl;\red255\green255\blue255;}
+\vieww15480\viewh16060\viewkind0
\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\ql\qnatural
-\f0\fs24 \cf0
-\f1\b\fs28 \cf2 b\cf0 Distributed.com, Inc.
-\f0\b0\fs24 \
-
-\fs20 2549 W. Golf Rd. #348\
- Hoffman Estates, IL 60194\
- Phone: (847) 372-3955\
- Fax: (847) 589-3738\
- Web: bdistributed.com\
- Email: info@bdistributed.com\
-
-\fs24 \
-Below is a quick reference for the BDAlias class.\
+\f0\fs24 \cf0 Below is a quick reference for the BDAlias class.\
\
-\f1\b Instance Methods
-\f0\b0 \
+\b Instance Methods
+\b0 \
initWithAliasHandle:\
initWithData:\
initWithPath:\
@@ -36,8 +24,8 @@ fullPath\
fullPathRelativeToPath:\
\
-\f1\b Class Methods
-\f0\b0 \
+\b Class Methods
+\b0 \
aliasWithAliasHandle:\
aliasWithData:\
aliasWithPath:\
@@ -46,117 +34,96 @@ aliasWithFSRef:\
aliasWithFSRef:relativeToFSRef:\
\
-\f1\b - (id)initWithAliasHandle:(AliasHandle)alias
-\f0\b0 \
+\b - (id)initWithAliasHandle:(AliasHandle)alias
+\b0 \
Initializes an alias object with the contents of a Carbon alias handle. This is the designated initializer.\
\
-\f1\b - (id)initWithData:(NSData *)data
-\f0\b0 \
+\b - (id)initWithData:(NSData *)data
+\b0 \
Initializes an alias object with the contents of a data object.\
\
-\f1\b - (id)initWithPath:(NSString *)fullPath
-\f0\b0 \
+\b - (id)initWithPath:(NSString *)fullPath
+\b0 \
Initializes an alias object to point to the object at the given path in the filesystem.\
\
-\f1\b - (id)initWithPath:(NSString *)path relativeToPath:(NSString *)relPath
-\f0\b0 \
+\b - (id)initWithPath:(NSString *)path relativeToPath:(NSString *)relPath
+\b0 \
Initializes an alias object to point to the object at the given path in the filesystem, relative to the given relative path.\
\
-\f1\b - (id)initWithFSRef:(FSRef *)ref
-\f0\b0 \
+\b - (id)initWithFSRef:(FSRef *)ref
+\b0 \
Initializes an alias object to point to the object represented by the given Carbon FSRef.\
\
-\f1\b - (id)initWithFSRef:(FSRef *)ref relativeToFSRef:(FSRef *)relRef
-\f0\b0 \
+\b - (id)initWithFSRef:(FSRef *)ref relativeToFSRef:(FSRef *)relRef
+\b0 \
Initializes an alias object to point to the object represented by the given Carbon FSRef, relative to the given relative Carbon FSRef.\
\
-\f1\b - (void)dealloc
-\f0\b0 \
+\b - (void)dealloc
+\b0 \
Releases resources held by an instance.\
\
-\f1\b - (AliasHandle)alias
-\f0\b0 \
+\b - (AliasHandle)alias
+\b0 \
Returns the internal Carbon alias handle used by an instance.\
\
-\f1\b - (void)setAlias:(AliasHandle)newAlias
-\f0\b0 \
+\b - (void)setAlias:(AliasHandle)newAlias
+\b0 \
Sets the internal Carbon alias handle used by an instance, releasing the previous alias handle (if any).\
\
-\f1\b - (NSData *)aliasData
-\f0\b0 \
+\b - (NSData *)aliasData
+\b0 \
Returns an autoreleased data object containing a copy of the alias data in this object.\
\
-\f1\b - (void)setAliasData:(NSData *)newAliasData
-\f0\b0 \
+\b - (void)setAliasData:(NSData *)newAliasData
+\b0 \
Sets the alias to use the alias record stored in the given data object. Discards any previous data.\
\
-\f1\b - (NSString *)fullPath
-\f0\b0 \
+\b - (NSString *)fullPath
+\b0 \
Returns an autoreleased string containing the full path of the object pointed to by an alias.\
\
-\f1\b - (NSString *)fullPathRelativeToPath:(NSString *)relPath
-\f0\b0 \
+\b - (NSString *)fullPathRelativeToPath:(NSString *)relPath
+\b0 \
Returns an autoreleased string containing the full path of the object pointed to by an alias, resolved relative to the other given full path.\
\
-\f1\b + (BDAlias *)aliasWithAliasHandle:(AliasHandle)alias\
-
-\f0\b0 Creates an autoreleased alias object with the contents of the given Carbon alias handle.\
-\
-
-\f1\b + (BDAlias *)aliasWithData:(NSData *)data\
+\b + (BDAlias *)aliasWithAliasHandle:(AliasHandle)alias\
-\f0\b0 Creates an autoreleased alias object with the contents of the given NSData object.\
+\b0 Creates an autoreleased alias object with the contents of the given Carbon alias handle.\
\
-\f1\b + (BDAlias *)aliasWithPath:(NSString *)fullPath\
+\b + (BDAlias *)aliasWithData:(NSData *)data\
-\f0\b0 Creates an autoreleased alias object pointing to the object at the given full path.\
+\b0 Creates an autoreleased alias object with the contents of the given NSData object.\
\
-\f1\b + (BDAlias *)aliasWithPath:(NSString *)path relativeToPath:(NSString *)relPath\
+\b + (BDAlias *)aliasWithPath:(NSString *)fullPath\
-\f0\b0 Creates an autoreleased alias object pointing to the object at the given path, relative to the given relative path.\
+\b0 Creates an autoreleased alias object pointing to the object at the given full path.\
\
-\f1\b + (BDAlias *)aliasWithFSRef:(FSRef *)ref\
+\b + (BDAlias *)aliasWithPath:(NSString *)path relativeToPath:(NSString *)relPath\
-\f0\b0 Creates an autoreleased alias object pointing to the object at the given Carbon FSRef.\
+\b0 Creates an autoreleased alias object pointing to the object at the given path, relative to the given relative path.\
\
-\f1\b + (BDAlias *)aliasWithFSRef:(FSREf *)ref relativeToFSRef:(FSRef *)relRef\
+\b + (BDAlias *)aliasWithFSRef:(FSRef *)ref\
-\f0\b0 Creates an autoreleased alias object pointing to the object at the given Carbon FSRef, relative to the given relative Carbon FSRef.\
+\b0 Creates an autoreleased alias object pointing to the object at the given Carbon FSRef.\
\
-\f1\b License Agreement\
+\b + (BDAlias *)aliasWithFSRef:(FSREf *)ref relativeToFSRef:(FSRef *)relRef\
-\f0\b0 By using or downloading this software, you agree to be bound by the following license. If you do not agree to be bound by the license, please destroy all copies of this software.\
-\
-Copyright \'a9 2001-2002, bDistributed.com, Inc.\
-All rights reserved.\
-\
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:\
-\
-\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\li580\fi-580\ql\qnatural
-\cf0 * 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 bDistributed.com, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. \
-\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\ql\qnatural
-\cf0 \
-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 THE REGENTS OR CONTRIBUTORS 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. \
-}
+\b0 Creates an autoreleased alias object pointing to the object at the given Carbon FSRef, relative to the given relative Carbon FSRef.}
View
21 License.rtf
@@ -1,21 +0,0 @@
-{\rtf1\mac\ansicpg10000\cocoartf102
-{\fonttbl\f0\froman\fcharset77 TimesNewRomanPSMT;}
-{\colortbl;\red255\green255\blue255;}
-\vieww9000\viewh9000\viewkind0
-\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\ql\qnatural
-
-\f0\fs24 \cf0 Copyright \'a9 2001-2002, bDistributed.com, Inc.\
-All rights reserved.\
-\
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:\
-\
-\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\li580\fi-580\ql\qnatural
-\cf0 * 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 bDistributed.com, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. \
-\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\ql\qnatural
-\cf0 \
-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 THE REGENTS OR CONTRIBUTORS 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. \
-}
View
41 README.markdown
@@ -0,0 +1,41 @@
+# BDAlias
+
+## What is BDAlias?
+
+BDAlias is a simple Cocoa class for dealing with alias records, a form of persistent file reference that is more robust and provides a better user experience than a textual path. Macintosh applications should always use alias records for persistent file references, and often for exchanging references to files with other applications.
+
+## How do I use BDAlias?
+
+"You've got the source."
+
+Seriously though, you create an instance of `BDAlias` using one of the `aliasWithXXX:` messages whenever you need to keep a persistent reference to a file around. If you're interacting with the rest of Cocoa, you'll probably use either `aliasWithPath:` or `aliasWithPath:relativeToPath:` When you're ready to "resolve" this reference to actually access a file, just send it a `fullPath` or `fullPathRelativeToPath:` message.
+
+Since the whole point of aliases is to persistently reference a file, you can easily convert an alias to an `NSData` object. Sending a `BDAlias` the `aliasData` message will return an autoreleased instance of `NSData` containing the record data ready to store wherever you can store an `NSData`.
+
+## Version History
+
+**1.2.2 (Apr 20 2009)**
+
+* [CHANGE] Changed to MIT License. ([Chris Hanson](https://twitter.com/eschaton/status/1567585805))
+
+**1.2.1 (Apr 19 2009)**
+
+* [FIX] Tweak for 64-bit compatibility. ([Alexander Rauchfuss](http://github.com/rentzsch/bdalias/commit/6c0106b2085b92f2c3212a2ec47e6bf5af43acbb))
+
+**1.2 (Apr 9 2007)**
+
+* [NEW] Add equality methods (Daniel Jalkut).
+* [CHANGE] Move project to http://rentzsch.com/trac.
+
+**1.1 (Oct 6 2006)**
+
+* Add `NSCoding` protocol support to ease persisting alias data. (rentzsch)
+* Add methods that return `NSError` objects. (rentzsch)
+
+**1.0 (2002)**
+
+* Initial release.
+
+##License
+
+BDAlias is now [released under the MIT License](http://opensource.org/licenses/mit-license.php).

0 comments on commit 54908dd

Please sign in to comment.
Something went wrong with that request. Please try again.