Skip to content

Commit 4bebb4c

Browse files
QataQata
committed
Update documentation
1 parent 9d48edb commit 4bebb4c

File tree

7 files changed

+31
-53
lines changed

7 files changed

+31
-53
lines changed

‎.jazzy.json

+18-33
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
2-
"xcodebuild_arguments": ["-project", "ReSwift.xcodeproj", "-scheme", "ReSwift-macOS"],
3-
"swift_version": "2.2",
2+
"xcodebuild_arguments": ["-project", "ReactiveReSwift.xcodeproj", "-scheme", "ReactiveReSwift-macOS"],
3+
"swift_version": "3.0.1",
44
"author": "ReSwift",
5-
"author_url": "https://github.com/ReSwift/ReSwift",
6-
"module": "ReSwift",
5+
"author_url": "https://github.com/ReSwift/ReactiveReSwift",
6+
"module": "ReactiveReSwift",
77
"readme": "Docs/tmp/compile/README.md",
88
"theme": "Docs/jazzy-theme/",
99

@@ -13,13 +13,11 @@
1313
"custom_categories": [{
1414
"name": "Documentation",
1515
"children": [
16-
"About ReSwift",
17-
"Why ReSwift",
16+
"About ReactiveReSwift",
17+
"Why ReactiveReSwift",
1818
"Getting Started Guide",
1919
"Installation",
20-
"Checking out Source Code",
21-
"Demo",
22-
"Extensions",
20+
"Reactive Extensions",
2321
"Example Projects",
2422
"Contributing",
2523
"Credits",
@@ -28,43 +26,30 @@
2826
"License"
2927
]
3028
}, {
31-
"name": "Stores",
29+
"name": "Core",
3230
"children": [
3331
"Store",
3432
"StoreType",
35-
"StoreSubscriber",
36-
"AnyStoreSubscriber"
37-
]
38-
}, {
39-
"name": "State",
40-
"children": [
41-
"StateType"
42-
]
43-
}, {
44-
"name": "Actions",
45-
"children": [
33+
"StateType",
4634
"Action",
47-
"StandardAction",
48-
"StandardActionConvertible",
49-
"ReSwiftInit"
50-
]
51-
}, {
52-
"name": "Reducers",
53-
"children": [
5435
"Reducer",
55-
"AnyReducer",
56-
"CombinedReducer"
36+
"Middleware"
5737
]
5838
}, {
59-
"name": "Utilities",
39+
"name": "Reactive",
6040
"children": [
61-
"Coding"
41+
"StreamType",
42+
"ObservablePropertyType",
43+
"SubscriptionReferenceType",
44+
"ObservableProperty",
45+
"ObservablePropertySubscriptionReference",
46+
"SubscriptionReferenceBag"
6247
]
6348
}],
6449

6550
"string-replacements": {
6651
"Docs/img": "img",
67-
"http://reswift.github.io/ReSwift/master/getting-started-guide.html": "getting-started-guide.html",
52+
"http://reswift.github.io/ReactiveReSwift/master/getting-started-guide.html": "getting-started-guide.html",
6853
"#contributing": "contributing.html"
6954
}
7055
}

‎.scripts/doc-preprocessor

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ if jazzy_conf['string-replacements']
9898
end
9999
end
100100

101-
version = `cat ReSwift.podspec| grep "version " | cut -d '"' -f 2`.strip
101+
version = `/usr/libexec/PlistBuddy -c "Print CFBundleShortVersionString" ReactiveReSwift/Info.plist`.strip
102102
if version
103103
result = result.sub '{{version}}', version
104104
end

‎.scripts/generate-docs

+4-6
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ fi
2525
# ----- Configuration
2626

2727
ORGANISATION=ReSwift
28-
NAME=ReSwift
28+
NAME=ReactiveReSwift
2929
TMP=Docs/tmp
3030
GITHUB=https://github.com/$ORGANISATION/$NAME
3131
URL=http://$ORGANISATION.github.io/$NAME
@@ -41,12 +41,10 @@ mkdir -p $TMP/{compile,docs,api}
4141
cp Docs/*.md $TMP/api/
4242

4343
# Split the README into sections
44-
$PREPROC README.md "$TMP/docs/About ReSwift.md" --section "About ReSwift" --title "About ReSwift"
45-
$PREPROC README.md "$TMP/docs/Why ReSwift.md" --section "Why ReSwift?" --title "Why ReSwift?"
44+
$PREPROC README.md "$TMP/docs/About ReactiveReSwift.md" --section "About ReactiveReSwift" --title "About ReactiveReSwift"
45+
$PREPROC README.md "$TMP/docs/Why ReactiveReSwift.md" --section "Why ReactiveReSwift?" --title "Why ReactiveReSwift?"
4646
$PREPROC README.md "$TMP/docs/Installation.md" --section "Installation" --title "Installation"
47-
$PREPROC README.md "$TMP/docs/Checking out Source Code.md" --section "Checking out Source Code" --title "Checking out Source Code"
48-
$PREPROC README.md "$TMP/docs/Demo.md" --section "Demo" --title "Demo"
49-
$PREPROC README.md "$TMP/docs/Extensions.md" --section "Extensions" --title "Extensions"
47+
$PREPROC README.md "$TMP/docs/Reactive Extensions.md" --section "Reactive Extensions" --title "Reactive Extensions"
5048
$PREPROC README.md "$TMP/docs/Example Projects.md" --section "Example Projects" --title "Example Projects"
5149
$PREPROC README.md "$TMP/docs/Credits.md" --section "Credits" --title "Credits"
5250
$PREPROC README.md "$TMP/docs/Get in touch.md" --section "Get in touch" --title "Get in touch"

‎.scripts/update-gh-pages

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ fi
1414
# ----- Configuration
1515

1616
ORGANISATION=ReSwift
17-
NAME=ReSwift
17+
NAME=ReactiveReSwift
1818
BRANCH=$([ "$TRAVIS_BRANCH" == "" ] && echo "master" || echo "$TRAVIS_BRANCH")
1919
SHA=`git rev-parse --verify HEAD --short`
2020
REPO=`git config remote.origin.url`

‎Docs/State.md

+3-7
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,12 @@ The application state is defined in a single data structure which should be a `s
22

33
The state `struct` should store your entire application state, that includes the UI state, the navigation state and the state of your model layer.
44

5-
Here's an example of a state `struct` as defined in the [Counter Example](https://github.com/ReSwift/CounterExample):
5+
Here's an example of a state `struct` as defined in the [Reactive Counter Example](https://github.com/Qata/ReactiveCounterExample):
66

77
```swift
8-
struct AppState: StateType, HasNavigationState {
8+
struct AppState: StateType {
99
var counter: Int = 0
10-
var navigationState = NavigationState()
1110
}
1211
```
1312

14-
There are multiple things to note:
15-
16-
1. Your app state `struct` needs to conform to the `StateType` protocol, currently this is just a marker protocol, but we will likely add requirements (such as the ability to [serialize the state](https://github.com/ReSwift/ReSwift/issues/3)) before v1.0.
17-
2. If you are including `SwiftRouter` in your project, your app state needs to conform to the `HasNavigationState` protocol. This means you need to add a property called `navigationState` to your state `struct`. This is the sub-state the router will use to store the current route.
13+
Your app state `struct` needs to conform to the `StateType` protocol.

‎ReactiveReSwift.xcodeproj/project.pbxproj

+2-2
Original file line numberDiff line numberDiff line change
@@ -1047,7 +1047,7 @@
10471047
INFOPLIST_FILE = ReactiveReSwift/Info.plist;
10481048
INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
10491049
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
1050-
PRODUCT_BUNDLE_IDENTIFIER = reswift.github.io.ReSwiftFRP;
1050+
PRODUCT_BUNDLE_IDENTIFIER = reswift.github.io.ReactiveReSwift;
10511051
PRODUCT_NAME = ReactiveReSwift;
10521052
SKIP_INSTALL = YES;
10531053
SWIFT_OPTIMIZATION_LEVEL = "-Onone";
@@ -1066,7 +1066,7 @@
10661066
INFOPLIST_FILE = ReactiveReSwift/Info.plist;
10671067
INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
10681068
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
1069-
PRODUCT_BUNDLE_IDENTIFIER = reswift.github.io.ReSwiftFRP;
1069+
PRODUCT_BUNDLE_IDENTIFIER = reswift.github.io.ReactiveReSwift;
10701070
PRODUCT_NAME = ReactiveReSwift;
10711071
SKIP_INSTALL = YES;
10721072
SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule";

‎ReactiveReSwift/CoreTypes/Store.swift

+2-3
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,8 @@ import Foundation
1111
/**
1212
This class is the default implementation of the `Store` protocol. You will use this
1313
store in most of your applications. You shouldn't need to implement your own store.
14-
You initialize the store with a reducer and an initial application state. If your app has multiple
15-
reducers you can combine them by initializng a `CombinedReducer` with all of your reducers as
16-
arguments.
14+
You initialize the store with a reducer and an initial application state,
15+
contained within an observable.
1716
*/
1817

1918
public class Store<ObservableProperty: ObservablePropertyType>: StoreType where ObservableProperty.ValueType: StateType {

0 commit comments

Comments
 (0)