Skip to content

Commit

Permalink
Updated README file
Browse files Browse the repository at this point in the history
  • Loading branch information
gimenete committed Nov 22, 2011
1 parent c29e283 commit 1c5eace
Showing 1 changed file with 2 additions and 27 deletions.
29 changes: 2 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,9 @@
What is IOS Boilerplate
-----------------------

Is a code base for iOS projects. Current version provides
Is a base template for iOS projects.

- BaseViewController with methods for secure handling of async http requests
- ImageManager: a class for downloading images asynchronously
- FastCell (inspired on [Atebits implementation](http://blog.atebits.com/2008/12/fast-scrolling-in-tweetie-with-uitableview/)) is a base class for implementing custom UITableViewCells with fast scrolling.
- ListViewController: a base class for creating ViewControllers with one UITableView that can be refreshed with a pull-down component.
- Place: a simple implementation of the MKAnnotation protocol
- DictionaryHelper: an NSDictionary helper with methods for safe handling of collections
- StringHelper: an NSString helper with methods for manipulating NSStrings. Including: trim, sha1 and urlEncode method.
- DataHelper: an NSData helper with one method: hexString. It is used inside StringHelper to calculate the sha1 hash hexstring representation of a given string

The project contains some examples with the use of those utility classes:

- Example that fetches a JSON object through an async HTTP request, and shows a progress HUD.
- Example that fetches a single image with ImageManager
- Example that combines FastCells with async image loading using ImageManager.
- Example of variable height table cells using FastCell.
- Example that shows how to extend ListViewController to create a tableview with a simple pull-down-to-refresh component.
- Example that shows how to implement a swipeable cell
- ViewController that uses MapOverlays and the Google Maps API to show the directions between two points.
- Search bar that autocompletes locations.
Please, go to [http://iosboilerplate.com/](http://iosboilerplate.com/) for more documentation and further information.

Some screenshots:

Expand All @@ -31,10 +13,3 @@ Some screenshots:

![Directions demo](https://github.com/gimenete/iOS-boilerplate/raw/master/shots/directions.png)


IOS Boilerplate includes the following third-party software:

- [ASIHTTPRequest](http://allseeing-i.com/ASIHTTPRequest/)
- [SVProgressHUD](https://github.com/samvermette/SVProgressHUD)
- [JSONKit](https://github.com/johnezang/JSONKit)
- [EGOTableViewPullRefresh](https://github.com/enormego/EGOTableViewPullRefresh)

0 comments on commit 1c5eace

Please sign in to comment.