Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
neilang committed May 6, 2012
1 parent 9eaab79 commit e11e116
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions ReadMe.md
@@ -1,12 +1,21 @@
NAMapKit NAMapKit
======== ========


Allows you to use custom maps in iOS applications and attempts to mimics some of the behaviour of the MapKit framework. Lets you drop MapKit style pins onto a standard UIImage - _also includes callouts, multi-colored pins, animation, zoom and gestures_.


Useage
![Screenshot 1](screenshot1.png)
![Screenshot 2](screenshot2.png)

Usage
------ ------


Create a NAMapView and give it a map to display. If you are using Interface Builder, add a UIScrollView and change the class to NAMapView (see demo app). Current version _requires ARC and iOS5_ (untested on iOS4). If you are developing for iOS3/4, checkout the version 1.0 tag of the repository.

Example code on how to use this framework can be found in the demo app.

If you are using Interface Builder, you can add a UIScrollView to your XIB and change the class to "NAMapView" to use the framework.



Attribution Attribution
----------- -----------
Expand All @@ -15,12 +24,5 @@ When using this code please include the following attribution:


**Includes NAMapKit code developed by [Neil Ang](http://neilang.com/) and [Tony Arnold](http://thecocoabots.com/).** **Includes NAMapKit code developed by [Neil Ang](http://neilang.com/) and [Tony Arnold](http://thecocoabots.com/).**


Copyright Have an app on the AppStore that's using NAMapKit? [Add it to our showcase](https://github.com/neilang/NAMapKit/wiki/Apps-using-NAMapKit).
---------

Copyright 2010 Neil Ang and Tony Arnold. See LICENSE for details.

Acknowledgements
----------------


The UICallOutView code was inspired by "MonoTouchCalloutView":http://github.com/edanuff/MonoTouchCalloutView
Binary file added screenshot1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshot2.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e11e116

Please sign in to comment.