diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..27643dba --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2014 Matt Donnelly + +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 new file mode 100644 index 00000000..dd1ff0d0 --- /dev/null +++ b/README.md @@ -0,0 +1,77 @@ +
+ +
+ +## Getting Started + +###Installation + +If you're using Xcode 6, Swifter can be installed by simply dragging the Swifter Xcode project into your own project and adding either the SwifteriOS or SwifterMac framework as an embeded framework. + +###Usage + +Instatiation With ACAccount: + +`let swifter = Swifter(account: twitterAccount)` + +Instansiation with OAuth: + +`let swifter = Swifter(consumerKey: "", consumerSecret: "")` + +OAuth Authorization: + + swifter.authorizeWithCallbackURL(callbackURL, success: { + accessToken, response in + + // ... + + }, + failure: { + + // ... + + }) + +Get Home Timeline: + + swifter.getStatusesHomeTimelineWithCount(20, sinceID: nil, maxID: nil, trimUser: true, contributorDetails: false, includeEntities: true, success: { + statuses, response in + + // ... + + }, failure: { + + // ... + + }) + + +Streaming API: + + swifter.getStatusesSampleDelimited(nil, stallWarnings: nil, progress: { + statuses, response in + + // ... + + }, failure: { + + // ... + + }) + +Status Update: + + swifter.postStatusUpdate("Hello, world", inReplyToStatusID: nil, lat: nil, long: nil, placeID: nil, displayCoordinates: nil, trimUser: nil, success: { + json, response in + + // ... + + }, failure: { + + // ... + + }) + +#License + +Swifter is licensed under the MIT License. See the LICENSE file for more information. diff --git a/swifter_logo.png b/swifter_logo.png new file mode 100644 index 00000000..d367b19c Binary files /dev/null and b/swifter_logo.png differ