Permalink
Browse files

Update README and write a CocoaPods spec.

Signed-off-by: Zachary Waldowski <zwaldowski@gmail.com>
  • Loading branch information...
1 parent c4de4cb commit 9b4600c6e7d84562d2fb6fb17ef4d8440f61ce42 @zwaldowski committed Feb 5, 2012
Showing with 51 additions and 84 deletions.
  1. +0 −1 .gitattributes
  2. +13 −13 .gitignore
  3. +18 −0 MBProgressHUD.podspec
  4. +20 −70 README.md
View
1 .gitattributes
@@ -1 +0,0 @@
-*.pbxproj -crlf -diff -merge
View
26 .gitignore
@@ -1,18 +1,18 @@
-# xcode noise
-build/
+# Xcode
+build/*
*.pbxuser
+*.swp
+!default.pbxuser
*.mode1v3
+!default.mode1v3
*.mode2v3
+!default.mode2v3
*.perspectivev3
-xcuserdata/
-
-# old skool
-.svn
-
-# osx noise
-.DS_Store
+!default.perspectivev3
+*.xcworkspace
+!default.xcworkspace
+xcuserdata
profile
-
-# vim noise
-*~
-*.swp
+*.moved-aside
+.DS_Store
+Notes.txt
View
18 MBProgressHUD.podspec
@@ -0,0 +1,18 @@
+Pod::Spec.new do |s|
+ s.name = 'MBProgressHUD'
+ s.platform = :ios
+ s.license = 'MIT'
+ s.summary = 'A dead simple, drop-in HUD view for iOS.'
+ s.homepage = 'https://github.com/zwaldowski/MBProgressHUD'
+ s.author = { 'Zachary Waldowski' => 'zwaldowski@gmail.com',
+ 'Matej Bukovinski' => 'matej@bukovinski.com',
+ 'Jonathan George' => 'jonathan@jdg.net' }
+ s.source = { :git => 'https://github.com/zwaldowski/MBProgressHUD.git' }
+ s.description = 'MBProgressHUD is a drop-in iOS class that displays a translucent HUD with a ' \
+ 'progress indicator and an optional label while work is being done. It is meant ' \
+ 'as an easy-to-use replacement for the undocumented, private class UIProgressHUD.'
+ s.source_files = '*.{h,m}'
+ s.resources = 'Images/*.png'
+ s.clean_paths = 'Doxyfile', 'HudDemo', 'HudDemo.xcodeproj', '.gitignore'
+ s.framework = 'QuartzCore'
+end
View
90 README.md
@@ -1,97 +1,47 @@
MBProgressHUD
=============
-MBProgressHUD is an iPhone drop-in class that displays a translucent HUD with a progress indicator and some optional labels while work is being done in a background thread. The HUD is meant as a replacement for the undocumented, private UIKit UIProgressHUD with some additional features.
+`MBProgressHUD` is a drop-in iOS class that displays a translucent HUD with a progress indicator and an optional label while work is being done. It is meant as an easy-to-use replacement for the undocumented, private class `UIProgressHUD`.
-MBProgressHUD is iOS4 and iPad compatible and released under the MIT license (see MBProgressHUD.h).
+`MBProgressHUD` is compatible with iOS 4 and up and released under the MIT license.
-[![](http://dl.dropbox.com/u/378729/MBProgressHUD/1-thumb.png)](http://dl.dropbox.com/u/378729/MBProgressHUD/1.png)
-[![](http://dl.dropbox.com/u/378729/MBProgressHUD/2-thumb.png)](http://dl.dropbox.com/u/378729/MBProgressHUD/2.png)
-[![](http://dl.dropbox.com/u/378729/MBProgressHUD/3-thumb.png)](http://dl.dropbox.com/u/378729/MBProgressHUD/3.png)
-[![](http://dl.dropbox.com/u/378729/MBProgressHUD/4-thumb.png)](http://dl.dropbox.com/u/378729/MBProgressHUD/4.png)
-[![](http://dl.dropbox.com/u/378729/MBProgressHUD/5-thumb.png)](http://dl.dropbox.com/u/378729/MBProgressHUD/5.png)
+[![Simple HUD](http://d.pr/3I3+)](http://d.pr/3I3+)
+[![With native label](http://d.pr/N42R+)](http://d.pr/N42R+)
+[![Determinate progress](http://d.pr/wukD+)](http://d.pr/wukD+)
+[![Custom view: success](http://d.pr/vlxv+)](http://d.pr/vlxv+)
+[![Custom view: failure](http://d.pr/lod2+)](http://d.pr/lod2+)
-Adding MBProgressHUD to your project
-====================================
+Installation
+============
-The simplest way to add the MBProgressHUD to your project is to directly add the `MBProgressHUD.h` and `MBProgressHUD.m` source files to your project.
+The simplest way to add the `MBProgressHUD` to your project is to directly add the source files to your project, as well as the four completion images.
-1. Download the latest code version from the repository (you can simply use the Download Source button and get the zip or tar archive of the master branch).
+1. Download the latest code version from the repository. You can simply use the Download Source button and get a zipball or tarball.
2. Extract the archive.
-3. Open your project in Xcode, than drag and drop `MBProgressHUD.h` and `MBProgressHUD.m` to your classes group (in the Groups & Files view).
-4. Make sure to select Copy items when asked.
+3. Open your project in Xcode, than drag and drop `MBProgressHUD.h` and `MBProgressHUD.m` to your Classes group (in the Groups & Files view). Make sure to select Copy Items when asked.
+4. Drag and drop the four images (`success.png`, `success@2x.png`, `error.png`, and `error@2x.png`) into the Resources group.
If you have a git tracked project, you can add MBProgressHUD as a submodule to your project.
-1. Move inside your git tracked project.
-2. Add MBProgressHUD as a submodule using `git submodule add git://github.com/matej/MBProgressHUD.git MBProgressHUD` .
-3. Open your project in Xcode, than drag and drop `MBProgressHUD.h` and `MBProgressHUD.m` to your classes group (in the Groups & Files view).
-4. Don't select Copy items and select a suitable Reference type (relative to project should work fine most of the time).
+1. `cd`` inside your git tracked project.
+2. Add `MBProgressHUD` as a submodule using `git submodule add git://github.com/matej/MBProgressHUD.git MBProgressHUD` .
+3. Open your project in Xcode, than drag and drop `MBProgressHUD.h` and `MBProgressHUD.m` to your classes group (in the Groups & Files view). Don't select Copy Items.
+4. Drag and drop the four images (`success.png`, `success@2x.png`, `error.png`, and `error@2x.png`) into the Resources group.
Usage
=====
-Extensive documentation is provided in the header file (MBProgressHUD.h). In additiona a full Xcode demo project is included in the Demo directory.
+Extensive documentation is provided in the header file. Additionally, a full Xcode demo project is included.
License
=======
This code is distributed under the terms and conditions of the MIT license.
-Copyright (c) 2011 Matej Bukovinski
+Copyright (c) 2010-2012 Jonathan George, Matej Bukovinski, Zachary Waldowski, and the MBProgressHUD contributors.
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.
-
-
-Change-log
-==========
-
-**Version 0.41** @ 03.01.12
-
-- Support for ARC.
-
-**Version 0.4** @ 25.07.10
-
-- Different animation modes. Default set to zoom.
-- Class convenience methods (tadelv - http://github.com/tadelv).
-- Autorotation when added to a UIWindow (wuf810 - http://github.com/wuf810).
-- Extended demo app.
-- Several smaller fixes.
-
-**Version 0.33** @ 27.03.10
-
-- Custom view operation mode added.
-- Fixed a memory leak.
-
-**Version 0.32** @ 4.01.10
-
-- Added minShowTime, graceTime, xOffset, yOffset.
-- Various fixes.
-
-**Version 0.31** @ 8.10.09
-
-- Fix for touch through during the fade-out animation.
-
-**Version 0.3** @ 30.9.09
-
-- Added show: and hide: methods.
-- Now using UIViews layoutSubviews to automate layout calls.
-- Added some floors to round pixel positions and thereby prevent unsharp views.
-- Some additional documentation and code cleanup.
-
-**Version 0.2** @ 21.7.09
-
-- Added determinate progress mode and switching capabilities between determinate and indeterminate modes.
-- Various bugfixes.
-
-**Version 0.11** @ 2.6.09.
-
-- Updated labelText and detailsLabelText properties to support text modifications while the HUD is being shown.
-
-**Version 0.1** @ 2.4.09
-
-- Initial release.
+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.

0 comments on commit 9b4600c

Please sign in to comment.