Added readme and license

getsling · Aug 17, 2012 · 43c090e · 43c090e
1 parent 4428789
commit 43c090e
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 3 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -0,0 +1,2 @@
+Kevin Renskers - https://github.com/kevinrenskers https://twitter.com/mixedcase
+Atli Thorbjornsson - https://github.com/atlithorn
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2012 Kevin Renskers (http://mixedcase.nl/)
+
+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.
diff --git a/README.md b/README.md
@@ -1,4 +1,37 @@
-LastFm
-======
+# LastFm
 
-Last.fm SDK for iOS
+Last.fm SDK for iOS
+
+
+## Usage
+
+    // Set the Last.fm session info
+    [LastFm sharedInstance].api_key = @"b25b959554ed76058ac220b7b2e0a026";
+    [LastFm sharedInstance].api_secret = @"xxx";
+    [LastFm sharedInstance].session = session;
+
+    // Get artist info
+    [[LastFm sharedInstance] getInfoForArtist:@"Pinn Floyd" successHandler:^(NSDictionary *result) {
+        NSLog(@"result: %@", result);
+    } failureHandler:^(NSError *error) {
+        NSLog(@"error: %@", error);
+    }];
+
+	// Get images for an artist
+    [[LastFm sharedInstance] getImagesForArtist:@"Cher" successHandler:^(NSArray *result) {
+        NSLog(@"result: %@", result);
+    } failureHandler:^(NSError *error) {
+        NSLog(@"error: %@", error);
+    }];
+
+Save the session you get with `getSessionForUser:password:successHandler:failureHandler:` somewhere, for example in `NSUserDefaults`, and on app start up set it back on `[LastFm sharedInstance].session`.
+
+
+## Issues and questions
+Have a bug? Please create an issue on GitHub!
+
+https://github.com/gangverk/LastFm/issues
+
+
+## License
+RemoteConfig is available under the MIT license. See the LICENSE file for more info.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Kevin Renskers - https://github.com/kevinrenskers https://twitter.com/mixedcase
		Atli Thorbjornsson - https://github.com/atlithorn