Skip to content

Commit 1885b94

Browse files
committed
[Docs] Update to new GH Markdown
Update syntax to be compatible with new GitHub Markdown.
1 parent a35d412 commit 1885b94

2 files changed

Lines changed: 22 additions & 22 deletions

File tree

Changelog.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@
88

99

1010

11-
#0.5.0
11+
# 0.5.0
1212

1313
*Released: 11/24/2016*
1414

1515
**Other:**
1616

1717
- Swift 3.0.1 / Xcode 8.1 updates - @DivineDominion, @frranck
1818

19-
#0.4.0
19+
# 0.4.0
2020

2121
*Released: 09/21/2016*
2222

@@ -25,15 +25,15 @@
2525
- Swift 3 Migration - @Ben-G
2626
- Documentation Fix - @excitedhoney
2727

28-
#0.3.1
28+
# 0.3.1
2929

3030
*Released: 07/16/2016*
3131

3232
**Fixes:**
3333

3434
- Expose `RouteHash` initializer publicly - @Ben-G
3535

36-
#0.3.0
36+
# 0.3.0
3737

3838
*Released: 06/28/2016*
3939

@@ -42,15 +42,15 @@
4242
- Update syntax to Swift 2.3 - @mjarvis
4343
- Update to ReSwift 2.0.0 - @Ben-G
4444

45-
#0.2.7
45+
# 0.2.7
4646

4747
*Released: 03/23/2016*
4848

4949
**Fixes:**
5050

5151
- Fix issue when checking out with Carthage (#20) - @Ben-G
5252

53-
#0.2.6
53+
# 0.2.6
5454

5555
*Released: 03/20/2016*
5656

@@ -65,14 +65,14 @@
6565
- Use a symbolic breakpoint in place of an `assertionFailure` for handling a stuck router - @Ben-G
6666
- Documentation Fix - @jschmid
6767

68-
#0.2.5
68+
# 0.2.5
6969

7070
*Released: 02/22/2016*
7171

7272
**API Changes:**
7373
- ReSwift-Router now uses the new substate selection API when subscribing to a store. As a result, the `HasNavigationState` protocol has been removed. This change also allows an app to have multiple routers. - @Ben-G
7474

75-
#0.2.4
75+
# 0.2.4
7676

7777
*Released: 01/23/2016*
7878

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,40 +11,40 @@ Using ReSwiftRouter you can navigate your app by defining the target location in
1111
mainStore.dispatch(
1212
SetRouteAction(["TabBarViewController", StatsViewController.identifier])
1313
)
14-
```
14+
```
1515

16-
#About ReSwiftRouter
16+
# About ReSwiftRouter
1717

1818
**ReSwiftRouter is still under development and the API is neither complete nor stable at this point.**
1919

2020
When building apps with ReSwift you should aim to cause **all** state changes through actions - this includes changes to the navigation state.
2121

2222
This requires to store the current navigation state within the app state and to use actions to trigger changes to that state - both is provided ReSwiftRouter.
2323

24-
#Installation
24+
# Installation
2525

2626

27-
##CocoaPods
27+
## CocoaPods
2828

2929
You can install ReSwiftRouter via CocoaPods by adding it to your `Podfile`:
3030

3131
use_frameworks!
3232

3333
source 'https://github.com/CocoaPods/Specs.git'
3434
platform :ios, '8.0'
35-
35+
3636
pod 'ReSwift'
3737
pod 'ReSwiftRouter'
38-
38+
3939
And run `pod install`.
4040

41-
##Carthage
41+
## Carthage
4242

4343
You can install ReSwiftRouter via [Carthage]() by adding the following line to your Cartfile:
4444

4545
github "ReSwift/ReSwiftRouter"
4646

47-
#Configuration
47+
# Configuration
4848

4949
Extend your app state to include the navigation state:
5050

@@ -67,7 +67,7 @@ router = Router(store: mainStore, rootRoutable: RootRoutable(routable: rootViewC
6767

6868
We'll discuss `Routable` in the next main section.
6969

70-
##Calling the Navigation Reducer
70+
## Calling the Navigation Reducer
7171

7272
The `NavigationReducer` is provided as part of `ReSwiftRouter`. You need to call it from within your top-level reducer. Here's a simple example from the specs:
7373

@@ -82,7 +82,7 @@ struct AppReducer: Reducer {
8282
```
8383
This will make reducer handle all routing relevant actions.
8484

85-
#Implementing `Routable`
85+
# Implementing `Routable`
8686

8787
ReSwiftRouter works with routes that are defined, similar to URLs, as a sequence of identifiers e.g. `["Home", "User", "UserDetail"]`.
8888

@@ -150,11 +150,11 @@ func popRouteSegment(identifier: RouteElementIdentifier,
150150
}
151151
```
152152

153-
##Calling the Completion Handler within Routables
153+
## Calling the Completion Handler within Routables
154154

155155
ReSwiftRouter needs to throttle the navigation actions, since many UI frameworks including UIKit don't allow to perform multiple navigation steps in parallel. Therefor every method of `Routable` receives a `completionHandler`. The router will not perform any further navigation actions until the completion handler is called.
156156

157-
#Changing the Current Route
157+
# Changing the Current Route
158158

159159
Currently the only way to change the current application route is by using the `SetRouteAction` and providing an absolute route. Here's a brief example:
160160

@@ -168,8 +168,8 @@ Currently the only way to change the current application route is by using the `
168168
As development continues, support for changing individual route segments will be added.
169169

170170

171-
#Contributing
171+
# Contributing
172172

173-
##Compiling & Running tests
173+
## Compiling & Running tests
174174

175175
ReSwiftRouter uses [Carthage]() for its development dependencies. To build or test any of the targets, run `carthage bootstrap`.

0 commit comments

Comments
 (0)