Skip to content

Commit fba9b27

Browse files
committed
Preparing for 2.0.beta.1 release
1 parent ec4b4da commit fba9b27

File tree

2 files changed

+32
-10
lines changed

2 files changed

+32
-10
lines changed

ECSlidingViewController.podspec

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
Pod::Spec.new do |s|
22
s.name = "ECSlidingViewController"
3-
s.version = "2.0.0"
3+
s.version = "2.0.beta.1"
44
s.summary = "View controller container that presents its child view controllers in two sliding layers. Inspired by the Path 2.0 and Facebook iPhone apps."
55
s.description = "ECSlidingViewController is a view controller container that presents its child view controllers in two layers. It provides functionality for sliding the top view to reveal the views underneath it. This functionality is inspired by the Path 2.0 and Facebook iPhone apps."
6-
s.homepage = "https://github.com/edgecase/ECSlidingViewController"
6+
s.homepage = "https://github.com/ECSlidingViewController/ECSlidingViewController"
77
s.license = 'MIT'
88
s.author = { "Mike Enriquez" => "[email protected]" }
9-
s.source = { :git => "https://github.com/edgecase/ECSlidingViewController.git", :tag => s.version.to_s }
9+
s.source = { :git => "https://github.com/ECSlidingViewController/ECSlidingViewController.git", :tag => s.version.to_s }
1010

1111
s.platform = :ios, '7.0'
1212
s.requires_arc = true

README.md

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
`ECSlidingViewController` is a view controller container that manages a layered interface. The top layer anchors to the left or right side of the container while revealing the layer underneath it. This is most commonly known as the "Side Menu", "Slide Out", "Hamburger Menu/Drawer/Sidebar", etc...
44

5-
![iPhone and iPad Mini screenshots](http://github.com/edgecase/ECSlidingViewController/wiki/readme-assets/readme-hero.png)
5+
![iPhone and iPad Mini screenshots](http://github.com/ECSlidingViewController/ECSlidingViewController/wiki/readme-assets/readme-hero.png)
66

77
Supports all screen sizes and orientations.
88

@@ -22,7 +22,7 @@ This feature is optional and everything can be done programmatically if you want
2222

2323
### Custom Transitions
2424

25-
If the default sliding animation or swiping interaction to move the top view doesn't suit your needs, then you can customize them.
25+
If the default sliding animation or swiping interaction to move the top view doesn't suit your needs, then you can customize them by providing your own.
2626

2727
Custom transitions use the new protocols introduced in iOS 7 while exposing an API similar to the API that the UIKit containers expose for custom transitions. You should feel right at home if you are familiar with the custom transition API in iOS 7.
2828

@@ -31,36 +31,58 @@ Custom transitions use the new protocols introduced in iOS 7 while exposing an A
3131
* iOS 7
3232
* Xcode 5
3333

34+
**Note**: For iOS 5-7 support, `ECSlidingViewController` version 1.x is [available on this branch](https://github.com/ECSlidingViewController/ECSlidingViewController/tree/1.x).
35+
3436
## Installation
3537

3638
Install with [CocoaPods](http://cocoapods.org) by adding the following to your Podfile:
3739

3840
``` ruby
3941
platform :ios, '7.0'
40-
pod 'ECSlidingViewController', '~> 2.0'
42+
pod 'ECSlidingViewController', '~> 2.0.beta'
4143
```
4244

43-
**Note**: We follow http://semver.org for versioning the API.
45+
**Note**: We follow http://semver.org for versioning the public API.
4446

4547
Or copy the `ECSlidingViewController/` directory from this repo into your project.
4648

47-
## Example Workspace Projects
49+
## Documentation
50+
51+
### Header Files
52+
53+
The public API is documented in the header files. It will automatically show up in Xcode 5's quick help, or you can view it online:
4854

49-
A good way to learn how to use `ECSlidingViewController` is to go through the example apps in Examples.xcworkspace. Each example has a README with an explanation of how things are done.
55+
TODO: Generate formatted docs and put online somewhere.
56+
57+
### Sample Code
58+
59+
A good way to learn how to use `ECSlidingViewController` is to go through the example apps in `Examples.xcworkspace`. Each example has a README with an explanation of how things are done.
5060

5161
* [BasicMenu](Examples/BasicMenu/). Complete example using Storyboards with minimal code.
5262
* [LayoutDemo](Examples/LayoutDemo/). This is a universal app showcasing the layout.
5363
* [TransitionFun](Examples/TransitionFun). See how custom transitions are done.
5464

5565
**Note**: There is a problem with the simulator flashing the animation when cancelling an interactive transition. This does NOT happen on the device.
5666

67+
### Wiki
68+
69+
The wiki contains guides that go into more detail on how to use specific features of `ECSlidingViewController`.
70+
71+
[ECSlidingViewController Wiki Homepage](http://github.com/ECSlidingViewController/ECSlidingViewController/wiki)
72+
73+
## Getting Help
74+
75+
If you need help using `ECSlidingViewController`, please post a question on [StackOverflow with the "ECSlidingViewController" tag](http://stackoverflow.com/questions/ask?tags=ecslidingviewcontroller). Also, the more context you can provide (such as sample projects) the easier it will be for you to get help.
76+
77+
If you think you found a problem with `ECSlidingViewController`, please [post an issue](https://github.com/ECSlidingViewController/ECSlidingViewController/issues). A sample project or fork of any of the examples demonstrating the problem will help us fix the issue more quickly.
78+
5779
## Credits
5880

5981
Created and maintained by [Mike Enriquez](http://enriquez.me).
6082

6183
[Neo Innovation](http://neo.com) (formerly known as EdgeCase) for allowing Mike to work on `ECSlidingViewController` on company time during its inception. He is no longer with the company, but continues to maintain the project.
6284

63-
And... to those of you who [contributed changes](https://github.com/edgecase/ECSlidingViewController/graphs/contributors) or [reported issues](https://github.com/edgecase/ECSlidingViewController/issues).
85+
And... to those of you who [contributed changes](https://github.com/ECSlidingViewController/ECSlidingViewController/graphs/contributors) or [reported issues](https://github.com/ECSlidingViewController/ECSlidingViewController/issues).
6486

6587
## MIT License
6688

0 commit comments

Comments
 (0)