v1.0

CariocaMenu.podspec

@@ -0,0 +1,16 @@
+Pod::Spec.new do |s|
+  s.name = 'CariocaMenu'
+  s.version = '1.0'
+  s.license = 'MIT'
+  s.summary = 'The fastest zero-tap iOS menu.'
+  s.homepage = 'https://github.com/'
+  s.social_media_url = 'https://twitter.com/arnaud_momo'
+  s.authors = { 'Arnaud Schloune' => '[email protected]' }
+  s.source = { :git => 'https://github.com/arn00s/cariocamenu.git', :tag => s.version }
+
+  s.ios.deployment_target = '8.0'
+
+  s.source_files = 'Library/*.swift'
+
+  s.requires_arc = true
+end

LICENSE

@@ -0,0 +1,21 @@
+ The MIT License (MIT)
+
+ Copyright (c) 2015 Arnaud Schloune
+
+ 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.

README.md

@@ -0,0 +1,118 @@
+![CariocaMenu: The fastest zero-tap iOS menu]
+
+CariocaMenu is a simple, elegant, fast, modern, innovative, ..., navigation menu for your iOS app.
+
+## Features
+
+- [x] Accessible from a single swipe of the screen edge
+- [x] Accessible with a tap on the indicator
+- [x] Customisation for each side of the screen
+- [x] Boomerang mode
+- [x] Full AutoLayout
+- [x] Easily customisable
+- [x] Complete Documentation
+
+## Requirements
+
+- Autolayout
+- iOS 8.0+
+- Xcode 7.0
+
+## Communication
+
+- If you **need help**, use [Stack Overflow](http://stackoverflow.com/questions/tagged/CariocaMenu). (Tag 'CariocaMenu')
+- If you'd like to **ask a general question**, use [Stack Overflow](http://stackoverflow.com/questions/tagged/CariocaMenu).
+- If you **found a bug**, open an issue.
+- If you **have a feature request**, open an issue.
+- If you **want to contribute**, submit a pull request.
+
+## Installation
+
+### CocoaPods
+
+Coming soon 
+
+### Manually
+
+If you prefer, you can integrate CariocaMenu into your project manually.
+
+#### Source File
+
+Simply add the `CariocaMenu.swift` source file directly into your project.
+
+---
+
+## Usage
+
+### Creating your menu
+
+```swift
+import CariocaMenu
+
+//Initialise the tableviewcontroller of the menu
+let menuCtrl = self.storyboard?.instantiateViewControllerWithIdentifier("MyMenu") as! MyMenuContentController
+
+//Set the tableviewcontroller for the menu
+menu = CariocaMenu(menuController: menuCtrl)
+
+```
+
+### Adding it to a view
+
+```swift
+menu.addInView(yourView)
+```
+
+### Boomerang
+
+A boomerang always comes back to it's original place (in theory).
+By default, the boomerang is set to `None`. It means that the menu will stay where the user let it.
+The two other boomerang options are :
+
+- `Vertical` : Will always come back at the same vertical position, but on the edge the user has chosen.
+```swift
+menu.boomerang = .Vertical
+```
+
+- `VerticalAndHorizontal` : Will always come back at the same position (vertical + same screen edge)
+```swift
+menu.boomerang = .VerticalAndHorizontal
+```
+
+## TODO
+
+- Add a `live tutorial` to indicate users how to get the most of this menu
+- Unit tests / UIAutomation Tests
+- Check support for Objective-C projects
+- Add emoji support instead of the menu images
+- Add live background update when preselecting a menu item. The goal is to preview the preselected view before selection (with a blur effect)
+
+## Known issues
+
+Check the ([GitHub issues](https://github.com/arn00s/CariocaMenu/issues))
+
+## FAQ
+
+### Why should I use `CariocaMenu`?
+
+You're starting a new iOS app, and you want to innovate on the user experience.
+
+### Why the name `CariocaMenu`?
+
+I didn't want to use the same naming convention that EVERYONE uses. I could have named it `ASSuperCoolMenu`, but it sucks.
+A `Carioca` is someone who lives in Rio de Janeiro. I lived there for two months, and I had this menu idea while walking on the beach 😁
+
+* * *
+
+## Contact
+
+- Twitter ([@arnaud_momo](https://twitter.com/arnaud_momo))
+- LinkedIn ([@arnaud Schloune](https://lu.linkedin.com/in/arnaud.schloune))
+
+### Creator
+
+- [Arnaud Schloune](http://github.com/arn00s) ([@arnaud_momo](https://twitter.com/arnaud_momo))
+
+## License
+
+CariocaMenu is released under the MIT license. See LICENSE for details.