Skip to content

Commit

Permalink
Updated License, Changelog, Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
iRare Media committed Oct 9, 2013
1 parent 331b92e commit 950e0df
Show file tree
Hide file tree
Showing 5 changed files with 95 additions and 83 deletions.
81 changes: 81 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
## Change Log
**iCloud Document Sync is a work in progress**. Please help us get all features working and working well. We believe that this project will help many developers by easing the burden of iCloud. Below are the changes for each major commit.

<table>
<tr><th colspan="2" style="text-align:center;"><b>Version 6.2</b></th></tr>
<tr>
<td>Adds new methods and improves other methods. Fixes issues with documentation spelling, etc.
<ul>
<li>A new method, <tt>getListOfCloudFiles</tt>, is now available. When called, it returns a list of files currently stored in your app's iCloud Documents directory. </li>
<li>Improved the delete document method. Fixes an issue where the document would not properly close and then delete - resulting in random errors, false positives, and inabaility to delete documents. Now, the <tt>deleteDocumentWithName:</tt> method works properly.</li>
<li>Fixed spelling issues with documentation</li>
<li>Created Macro for Document Directory</li>
</ul>
</td>
</tr>
<tr><th colspan="2" style="text-align:center;"><b>Version 6.1</b></th></tr>
<tr>
<td>The use of delegates has been tuned down in favor of completion handlers. Some methods have been deprecated and replaced as a result. Others have been improved.
<ul>
<li>The <tt>iCloudError</tt> delegate method has been replaced with completion blocks. Some completion blocks now contain an NSError parameter which will contain information about any errors that may occur during a file operation. </li>
<li>A new delegate method has been added to handle file conflicts.</li>
<li>Three methods have been deprecated in favor of newer methods that provide more information using completion handlers rather than delegates.</li>
<li>The new method, uploadLocalOfflineDocumentsWithDelegate, has undergone numerous improvements. File conflict handling during upload is now supported - conflicts are automatically delt with. If a conflict cannot be resolved, the new <tt>iCloudFileUploadConflictWithCloudFile:andLocalFile:</tt> delegate method is called. This method no longer prevents <tt>sqlite</tt> files from being uploaded - now only hidden files aren't uploaded.</li>
<li>Major documentation improvements to both the DocSet and the Readme.</li>
</ul>
</td>
</tr>
<tr><th colspan="2" style="text-align:center;"><b>Version 6.0</b></th></tr>
<tr>
<td>Huge UIDocument improvements. iCloud Document Sync now uses UIDocument to open, save, and maintain files. All methods are more stable. Fetching files is faster and more efficient. Many delegate methods have been replaced with completion blocks.
</td>
</tr>
<tr><th colspan="2" style="text-align:center;"><b>Version 5.0</b></th></tr>
<tr>
<td>All methods have been completely revised and improved. Code is much cleaner. Now uses more efficient UIDocument structure than NSFileManager. Project now also includes a Framework which can be used for easy addition to projects. Better documentation, new methods, and more!
</td>
</tr>
</table>

<table>
<tr><th colspan="2" style="text-align:center;">Version 4.3.1</th></tr>
<tr>
<td>License Update. Readme Update. </td>
</tr>
<tr><th colspan="2" style="text-align:center;">Version 4.3</th></tr>
<tr>
<td>New delegate methods for error reporting and file downloading. File downloading introduced but not implemented. Updated Readme.</td>
</tr>
<tr><th colspan="2" style="text-align:center;">Version 4.2</th></tr>
<tr>
<td>Fixed errors when uploading files</td>
</tr>
<tr><th colspan="2" style="text-align:center;">Version 4.1</th></tr>
<tr>
<td>Updated Readme</td>
</tr>
<tr><th colspan="2" style="text-align:center;"><b>Version 4.0</b></th></tr>
<tr>
<td>Upload and retrieve files with greater ease </td>
</tr>
<tr><th colspan="2" style="text-align:center;">Version 3.0</th></tr>
<tr>
<td>iCloud Syncing now allows for the uploading of all files in the local directory with one call. Gets changes every time iCloud notifies of a change</td>
</tr>
<tr><th colspan="2" style="text-align:center;">Version 2.1</th></tr>
<tr>
<td>Changed the File List to an `NSMutableArray` for better flexibility</td>
</tr>
<tr><th colspan="2" style="text-align:center;">Version 2.0</th></tr>
<tr>
<td>New delegate methods</td>
</tr>
<tr><th colspan="2" style="text-align:center;"><b>Version 1.1</b></th></tr>
<tr>
<td>Add ability to remove documents from iCloud and local directory</td>
</tr>
<tr><th colspan="2" style="text-align:center;"><b>Version 1.0</b></th></tr>
<tr>
<td>Initial Commit</td>
</tr>
</table>
8 changes: 8 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## License
The MIT License (MIT). Copyright (c) 2013 iRare Media

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
85 changes: 2 additions & 83 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ iCloud Document Sync uses UIDocument and NSData to store and manage files. All o

To create a new document or save an exisiting one (close the document), use the method below.

[iCloud saveDocumentWithName:@"Name.ext" withContent:[NSData data] withDelegate:self completion:^(UIDocument *cloudDocument, NSData *documentData, NSError *error) {
[iCloud saveDocumentWithName:@"Name.ext" withContent:[NSData data] completion:^(UIDocument *cloudDocument, NSData *documentData, NSError *error) {
if (error == nil) {
// Code here to use the UIDocument or NSData objects which have been passed with the completion handler
}
Expand All @@ -72,7 +72,7 @@ Note the `repeatingHandler` block. This block is called everytime a local file i
### Removing Documents
You can delete documents from iCloud by using the method below. The completion block is called when the file is successfully deleted.

[iCloud deleteDocumentWithName:@"docName.ext" withDelegate:self completion:^{
[iCloud deleteDocumentWithName:@"docName.ext" completion:^(NSError *error) {
// Completion handler could be used to update your UI and tell the user that the document was deleted
}];

Expand Down Expand Up @@ -132,84 +132,3 @@ Although this project is a work in progress, we have gone to great lengths to pr
- Every bit of memory intensive code (pretty much anything related to iCloud) is performed on a separate background thread to prevent clogs in the UI.
- Each method is prepared to continue execution even when the user sends the app into the background.
- iCloud Document Sync uses `NSLog` , delegate methods, and completion handlers, to show you what is happening.
- We're working hard to update this library for iOS 7. We plan to have an update ready when iOS 7 goes public.

## Change Log
**iCloud Document Sync is a work in progress**. Please help us get all features working and working well. We believe that this project will help many developers by easing the burden of iCloud. Below are the changes for each major commit.

<table>
<tr><th colspan="2" style="text-align:center;"><b>Version 6.1</b></th></tr>
<tr>
<td>The use of delegates has been tuned down in favor of completion handlers. Some methods have been deprecated and replaced as a result. Others have been improved.
<ul>
<li>The <tt>iCloudError</tt> delegate method has been replaced with completion blocks. Some completion blocks now contain an NSError parameter which will contain information about any errors that may occur during a file operation. </li>
<li>A new delegate method has been added to handle file conflicts.</li>
<li>Three methods have been deprecated in favor of newer methods that provide more information using completion handlers rather than delegates.</li>
<li>The new method, uploadLocalOfflineDocumentsWithDelegate, has undergone numerous improvements. File conflict handling during upload is now supported - conflicts are automatically delt with. If a conflict cannot be resolved, the new <tt>iCloudFileUploadConflictWithCloudFile:andLocalFile:</tt> delegate method is called. This method no longer prevents <tt>sqlite</tt> files from being uploaded - now only hidden files aren't uploaded.</li>
<li>Major documentation improvements to both the DocSet and the Readme.</li>
</ul>
</td>
</tr>
<tr><th colspan="2" style="text-align:center;"><b>Version 6.0</b></th></tr>
<tr>
<td>Huge UIDocument improvements. iCloud Document Sync now uses UIDocument to open, save, and maintain files. All methods are more stable. Fetching files is faster and more efficient. Many delegate methods have been replaced with completion blocks.
</td>
</tr>
<tr><th colspan="2" style="text-align:center;"><b>Version 5.0</b></th></tr>
<tr>
<td>All methods have been completely revised and improved. Code is much cleaner. Now uses more efficient UIDocument structure than NSFileManager. Project now also includes a Framework which can be used for easy addition to projects. Better documentation, new methods, and more!
</td>
</tr>
</table>

<table>
<tr><th colspan="2" style="text-align:center;">Version 4.3.1</th></tr>
<tr>
<td>License Update. Readme Update. </td>
</tr>
<tr><th colspan="2" style="text-align:center;">Version 4.3</th></tr>
<tr>
<td>New delegate methods for error reporting and file downloading. File downloading introduced but not implemented. Updated Readme.</td>
</tr>
<tr><th colspan="2" style="text-align:center;">Version 4.2</th></tr>
<tr>
<td>Fixed errors when uploading files</td>
</tr>
<tr><th colspan="2" style="text-align:center;">Version 4.1</th></tr>
<tr>
<td>Updated Readme</td>
</tr>
<tr><th colspan="2" style="text-align:center;"><b>Version 4.0</b></th></tr>
<tr>
<td>Upload and retrieve files with greater ease </td>
</tr>
<tr><th colspan="2" style="text-align:center;">Version 3.0</th></tr>
<tr>
<td>iCloud Syncing now allows for the uploading of all files in the local directory with one call. Gets changes every time iCloud notifies of a change</td>
</tr>
<tr><th colspan="2" style="text-align:center;">Version 2.1</th></tr>
<tr>
<td>Changed the File List to an `NSMutableArray` for better flexibility</td>
</tr>
<tr><th colspan="2" style="text-align:center;">Version 2.0</th></tr>
<tr>
<td>New delegate methods</td>
</tr>
<tr><th colspan="2" style="text-align:center;"><b>Version 1.1</b></th></tr>
<tr>
<td>Add ability to remove documents from iCloud and local directory</td>
</tr>
<tr><th colspan="2" style="text-align:center;"><b>Version 1.0</b></th></tr>
<tr>
<td>Initial Commit</td>
</tr>
</table>

## License
The MIT License (MIT). Copyright (c) 2013 iRare Media

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
4 changes: 4 additions & 0 deletions iCloud.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@
99670E021806160E005BC6B7 /* README.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = README.md; sourceTree = "<group>"; };
99670E0418061613005BC6B7 /* com.iRareMedia.iCloudSDK.docset */ = {isa = PBXFileReference; lastKnownFileType = wrapper; path = com.iRareMedia.iCloudSDK.docset; sourceTree = "<group>"; };
99670E0518061613005BC6B7 /* iRareMedia.atom */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = iRareMedia.atom; sourceTree = "<group>"; };
99670E49180622F6005BC6B7 /* CHANGELOG.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = CHANGELOG.md; sourceTree = "<group>"; };
99670E4A180622F6005BC6B7 /* LICENSE.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = LICENSE.md; sourceTree = "<group>"; };
996A9B7F177C8DCA0030039A /* UIKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = UIKit.framework; path = System/Library/Frameworks/UIKit.framework; sourceTree = SDKROOT; };
996A9B82177C8DCA0030039A /* CoreGraphics.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = CoreGraphics.framework; path = System/Library/Frameworks/CoreGraphics.framework; sourceTree = SDKROOT; };
9994D1A416FE3ABF00AB071B /* libiCloud.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = libiCloud.a; sourceTree = BUILT_PRODUCTS_DIR; };
Expand Down Expand Up @@ -97,6 +99,8 @@
isa = PBXGroup;
children = (
99670E021806160E005BC6B7 /* README.md */,
99670E49180622F6005BC6B7 /* CHANGELOG.md */,
99670E4A180622F6005BC6B7 /* LICENSE.md */,
9994D1A916FE3ABF00AB071B /* iCloud */,
9994D1A616FE3ABF00AB071B /* Frameworks */,
9994D1A516FE3ABF00AB071B /* Products */,
Expand Down
Binary file not shown.

0 comments on commit 950e0df

Please sign in to comment.