Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Ashley Richards committed Dec 22, 2016
1 parent 746630a commit 4987e31
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 20 deletions.
Binary file not shown.
35 changes: 15 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@


# ARWhatsNew
A simple and light-weight What's New modal for new app updates.

Expand All @@ -20,9 +18,10 @@ This neat tool allows you to simply present a modal to your users to tell them W
| **acceptButtonText** | `NSString` | Changes default text for button instead of the default "Get Started" |
| **releaseNotes** | `NSString` | The release notes for the release |
| **disableReadAllRequired** | `BOOL` | Disable `acceptButton` from being disabled until user scrolls to bottom. |
| **resetWhatsNew** | `Void` | Resets current version `whatsNew_x` key in `NSUserDefault` |
| **appVersion** | `NSString` | Gets current app short version code. E.g. `1.0` |
| **whatsNewNotShown** | `BOOL` | Disable `acceptButton` from being disabled until user scrolls to bottom. |
| **majorReleasesOnly** | `BOOL` | Show WhatsNew modal for only x.x formatted versions. App versions with x.x.x or greater will be ignored. |
| **resetWhatsNew** | `Void` | Resets saved `NSUserDefaults` key that determines whether WhatsNew has been seen or not. |
| **appVersion** | `NSString` | Gets current app short version code. E.g. `x.x` |
| **showWhatsNew** | `Void` | One line of code to determine whether WhatsNew has been seen or not. |

# Compatibility and Requirements

Expand All @@ -45,32 +44,28 @@ Place in **ViewDidAppear**
vc.secondaryColor = [UIColor yellowColor];
vc.acceptButtonText = @"START APP";
vc.disableReadAllRequired = YES;
if ([vc whatsNewAlreadyShown]) {
[self presentViewController:vc animated:YES completion:nil];
}
vc.majorReleasesOnly = YES;
[vc showWhatsNew];

### Automatic Title Colour Change

**ARWhatsNew** automatically changes the `textColor` acording to the primary and secondary colors you provide. For example, if you provide a black background then the text will turn white and vice-versa.

### Checking Whats New has already been seen
**ARWhatsNew** provides a simple `BOOL` called `whatsNewNotShown` that returns:
**ARWhatsNew** now does all the work for you. simply just call:

- **`YES`** - If user **HASN'T** seen Whats New
- **`NO`** - If the user **HAS** seen Whats New
[[[ARWhatsNew alloc] init] showWhatsNew];


if ([ARWhatsNew alloc] init] whatsNewNotShown]) {
// Present modal
}
This function checks the `NSUserDefault` to determine whether the modal has already been seen or not. If the user has not seen WhatsNew, then it will present the modal.

# Planned For The Future
- Automatically check `appid` in App Store.
- Get release notes from App Store.
- Only show Whats New for major releases. (opt.)
- SHOW Whats New if version is `2.x`
- DONT show Whats New for minimal version `2.x.x`
- <s>Only show Whats New for major releases. (opt.)</s>
- <s>SHOW Whats New if version is `2.x`</s>
- <s>DONT show Whats New for minimal version `2.x.x`</s>

If you have any requests of what you would like to see in the future please get in contact via [Twitter](https://twitter.com/DocAsh59) or [create a new issue](https://github.com/docash59/ARWhatsNew/issues) on GitHub.

# Contact & Support
I am available on [Twitter](https://twitter.com/DocAsh59) or [Create a new Issue](https://github.com/docash59/ARWhatsNew/issues)
I am available on [Twitter](https://twitter.com/DocAsh59) or [create a new issue](https://github.com/docash59/ARWhatsNew/issues) on GitHub.

0 comments on commit 4987e31

Please sign in to comment.