diff --git a/README.md b/README.md index 7d357e9..23c4455 100644 --- a/README.md +++ b/README.md @@ -84,39 +84,42 @@ end # Getting Started -1. Check out the [Getting Started Guide](https://github.com/clearsightstudio/ProMotion/wiki/Guide:-Getting-Started) in the wiki +1. Check out the [Getting Started Guide](https://github.com/clearsightstudio/ProMotion/blob/master/docs/Guides/Guide%20-%20Getting%20Started.md) 2. Watch the excellent [MotionInMotion screencast about ProMotion](https://motioninmotion.tv/screencasts/8) (very reasonably priced subscription required) 3. Follow a tutorial: [Building an ESPN app using RubyMotion, ProMotion, and TDD](http://jamonholmgren.com/building-an-espn-app-using-rubymotion-promotion-and-tdd) -4. Read the updated and exhaustive [Wiki](https://github.com/clearsightstudio/ProMotion/wiki) +4. Read the [Documentation](https://github.com/clearsightstudio/ProMotion/blob/master/docs) # Changelog -## Version 2.2.0 +## Version 2.3.0 This release includes several new features and is backwards compatible with all 2.x releases. -* PM::TableScreen: You can now set a custom table view header view ([thanks Mark Rickert](https://github.com/clearsightstudio/ProMotion/pull/556)) -* PM::TableScreen refreshable: Refresh controls now show when programmatically initiating refresh ([thanks Mark Rickert](https://github.com/clearsightstudio/ProMotion/pull/569)) -* PM::TableScreen: Added reorderable ([thanks Mark Rickert](https://github.com/clearsightstudio/ProMotion/pull/569)) -* PM::TableScreen: Added auto height feature ([thanks Carlin Isaacson](https://github.com/clearsightstudio/ProMotion/pull/574)) -* PM::Screen: The navigation controller bottom toolbar will auto-hide when passed nil or false ([thanks Mark Rickert](https://github.com/clearsightstudio/ProMotion/pull/577)) -* PM::Screen: You can now choose a status bar style ([thanks Mark Rickert](https://github.com/clearsightstudio/ProMotion/pull/563)) -* Added `on_load` and `on_styled` hooks for UIViews that implement those methods ([Jamon Holmgren](https://github.com/clearsightstudio/ProMotion/pull/567)) -* Fixed an issue where cell properties would be applied twice unnecessarily ([Jamon Holmgren](https://github.com/clearsightstudio/ProMotion/pull/573)) +* PR #618 Allow search bar to be hidden initially +* PR #606 Adds capability for table_footer_view +* PR #602 Add image inset support for tab bar item +* PR #595 Feature/support module +* PR #582 Allow setting of multiple nav bar buttons instead of just one left an one right +* PR #581 Adds on_tab_selected +* PR #579 implemented nav_bar_button class method RE #272 +* PR #565 Adds header_will_display method to PM::TableScreen +* PR #663 Adds `on_load` back to cell dequeue code +* PR #641 Custom search for PM::TableScreen +* PR #658 Fix cell height issue # Apps built on ProMotion [Apps built on ProMotion](http://promotion.readthedocs.org/en/master/ProMotion%20Apps/) -##Your app +## Your app -Tweet [@jamonholmgren](https://twitter.com/jamonholmgren) if you built an app in ProMotion and want it included! +Open a pull request! # API Reference We've created a comprehensive and always updated wiki with code examples, usage examples, and API reference. -### [ProMotion API Reference](http://promotion.readthedocs.org/en/master/) +### [ProMotion Documentation](https://github.com/clearsightstudio/ProMotion/blob/master/docs) # Help diff --git a/docs/Guide - Getting Started.md b/docs/Guides/Guide - Getting Started.md similarity index 100% rename from docs/Guide - Getting Started.md rename to docs/Guides/Guide - Getting Started.md diff --git a/docs/Guide - Making Your Own Screens.md b/docs/Guides/Guide - Making Your Own Screens.md similarity index 100% rename from docs/Guide - Making Your Own Screens.md rename to docs/Guides/Guide - Making Your Own Screens.md diff --git a/docs/Migration Guide - ProMotion-1.2-to-2.0.md b/docs/Guides/Migration Guide - ProMotion-1.2-to-2.0.md similarity index 100% rename from docs/Migration Guide - ProMotion-1.2-to-2.0.md rename to docs/Guides/Migration Guide - ProMotion-1.2-to-2.0.md diff --git a/docs/README.md b/docs/README.md index fa14fc0..87f043f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,12 +1,12 @@ -## Welcome to the ProMotion wiki! +## Welcome to the ProMotion docs! -Documentation is targeting ProMotion 2.2.0. Any exceptions will be noted. +Documentation is targeting ProMotion 2.3.x. Any exceptions will be noted. If you have a problem with *any* of the documentation, *please* [open an issue](https://github.com/clearsightstudio/ProMotion/issues) so we can resolve it quickly. ### Getting Started -#### [Getting Started with ProMotion](https://github.com/clearsightstudio/ProMotion/wiki/Guide:-Getting-Started) +#### [Getting Started with ProMotion](./Reference/Guide - Getting Started.md) Everything you need to know to install ProMotion and create your first iPhone app. diff --git a/docs/API Reference - Command Line Tool.md b/docs/Reference/API Reference - Command Line Tool.md similarity index 100% rename from docs/API Reference - Command Line Tool.md rename to docs/Reference/API Reference - Command Line Tool.md diff --git a/docs/API Reference - ProMotion Delegate.md b/docs/Reference/API Reference - ProMotion Delegate.md similarity index 98% rename from docs/API Reference - ProMotion Delegate.md rename to docs/Reference/API Reference - ProMotion Delegate.md index 6c04cc4..a6ac1b6 100644 --- a/docs/API Reference - ProMotion Delegate.md +++ b/docs/Reference/API Reference - ProMotion Delegate.md @@ -60,22 +60,22 @@ end Fired just before the app loads. Not usually necessary. -#### on_activate - -Fires when the app becomes active. - #### will_deactivate Fires when the app is about to become inactive. -#### on_enter_background +#### on_activate -Fires when the app enters the background. +Fires when the app becomes active. #### will_enter_foreground Fires just before the app enters the foreground. +#### on_enter_background + +Fires when the app enters the background. + #### open_tab_bar(*screens) Opens a UITabBarController with the specified screens as the root view controller of the current app. @@ -95,7 +95,7 @@ Opens a UISplitScreenViewController with the specified screens as the root view ```ruby def on_load(app, options) - open_split_screen MasterScreen, DetailScreen, + open_split_screen MasterScreen, DetailScreen, icon: "split-icon", title: "Split Screen Title" # optional end ``` @@ -158,4 +158,4 @@ References the root screen for the app. def some_method self.home_screen #=> PM::Screen instance end -``` \ No newline at end of file +``` diff --git a/docs/API Reference - ProMotion Logger.md b/docs/Reference/API Reference - ProMotion Logger.md similarity index 100% rename from docs/API Reference - ProMotion Logger.md rename to docs/Reference/API Reference - ProMotion Logger.md diff --git a/docs/API Reference - ProMotion MapScreen.md b/docs/Reference/API Reference - ProMotion MapScreen.md similarity index 100% rename from docs/API Reference - ProMotion MapScreen.md rename to docs/Reference/API Reference - ProMotion MapScreen.md diff --git a/docs/API Reference - ProMotion PushNotification.md b/docs/Reference/API Reference - ProMotion PushNotification.md similarity index 100% rename from docs/API Reference - ProMotion PushNotification.md rename to docs/Reference/API Reference - ProMotion PushNotification.md diff --git a/docs/API Reference - ProMotion Screen.md b/docs/Reference/API Reference - ProMotion Screen.md similarity index 100% rename from docs/API Reference - ProMotion Screen.md rename to docs/Reference/API Reference - ProMotion Screen.md diff --git a/docs/API Reference - ProMotion SplitScreen.md b/docs/Reference/API Reference - ProMotion SplitScreen.md similarity index 100% rename from docs/API Reference - ProMotion SplitScreen.md rename to docs/Reference/API Reference - ProMotion SplitScreen.md diff --git a/docs/API Reference - ProMotion Styling.md b/docs/Reference/API Reference - ProMotion Styling.md similarity index 100% rename from docs/API Reference - ProMotion Styling.md rename to docs/Reference/API Reference - ProMotion Styling.md diff --git a/docs/API Reference - ProMotion Table - Cell Options.md b/docs/Reference/API Reference - ProMotion Table - Cell Options.md similarity index 100% rename from docs/API Reference - ProMotion Table - Cell Options.md rename to docs/Reference/API Reference - ProMotion Table - Cell Options.md diff --git a/docs/API Reference - ProMotion TableScreen.md b/docs/Reference/API Reference - ProMotion TableScreen.md similarity index 100% rename from docs/API Reference - ProMotion TableScreen.md rename to docs/Reference/API Reference - ProMotion TableScreen.md diff --git a/docs/API Reference - ProMotion Tabs.md b/docs/Reference/API Reference - ProMotion Tabs.md similarity index 100% rename from docs/API Reference - ProMotion Tabs.md rename to docs/Reference/API Reference - ProMotion Tabs.md diff --git a/docs/API Reference - ProMotion WebScreen.md b/docs/Reference/API Reference - ProMotion WebScreen.md similarity index 100% rename from docs/API Reference - ProMotion WebScreen.md rename to docs/Reference/API Reference - ProMotion WebScreen.md