Updated README

README.md

@@ -5,8 +5,7 @@
       \/_/  \/_/   \/_/\/_/   \/_/   \/_____/   \/_____/   \/_____/   \/_/ /_/   \/_____/ 
                                                                                       
 
-Getting Started
----------------
+#Getting the code
 
 First checkout the code and pulldown the required dependencies as submodules:
 
@@ -17,25 +16,28 @@ First checkout the code and pulldown the required dependencies as submodules:
 
 Now open up MailCore.xcodeproj and build either the iOS static library or the Mac OS X framework depending on your needs.
 
-Upgrading from previous version
--------
-TODO:Fill this out, right now these are just notes
+#Website
 
-- Not backwards compatible
-- fetchBody -> fetchBodyStructure
-- New methods for fetching message lists
-- Both - (NSSet *)messageObjectsFromIndex:(unsigned int)start toIndex:(unsigned int)end and - (NSSet *)messageListWithFetchAttributes:(NSArray *)attributes are gone.
-- Moved to NSError
-- Message to, from, sender, bcc, cc, subject are nil when not downloaded or message doesn't have them
-- Changed how UID is stored, now just an integer, UID validity is separate
-- isUIDValid is gone
+The official site contains documentation, FAQs, and step by step instructions on how to include MailCore
 
+http://www.libmailcore.com
 
-Contact
--------
+# Migrating to Version 1.0 [migrating]
 
-If you have any questions contact me:
+The latest version of MailCore is no longer backwards compatible with earlier versions. I tried to keep backwards compatibility, but it became too complex, sorry :(
 
-Matt Ronge
+The biggest change is that exceptions are no longer used. Instead each method either returns a BOOL or an object that can be checked for success. If an error occurs each object has a `- (NSError *)lastError` method that can be consulted.
+
+Here are a list of major changes:
 
+* The method `- (int)fetchBody` has been renamed to `- (BOOL)fetchBodyStructure`
+* The methods `messageObjectsFromIndex:toIndex:` and `messageListWithFetchAttributes:` have both been removed. They've been replaced by the new and improved `messagesFromSequenceNumber:to:withFetchAttributes:` and `messagesFromUID:to:withFetchAttributes:`. Please see the header file CTCoreFolder.m for details.
+- NSException is no longer used, instead NSError is used.
+- A CTCoreMessage's to, from, sender, bcc, cc, and subject values are nil when they have not been downloaded or message doesn't have them
+- Message UIDs are now NSUIntegers instead of NSStrings
+- `- (BOOL)isUIDValid:(NSString *)uid` has been removed. Instead check your uid validity value manually
+
+Thanks,
+Matt Ronge
+@mronge
 mronge@mronge.com