Skip to content

Commit 111bb12

Browse files
committed
updating readme for 0.4
Change-Id: Icc0535cf4dc2869fcdfb0392b54cdd6b71df5b0a
1 parent 6137b52 commit 111bb12

File tree

2 files changed

+16
-8
lines changed

2 files changed

+16
-8
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,23 @@ FirebaseUI supports iOS 7.0+. We recommend using [CocoaPods](http://cocoapods.or
1212
the following to your `Podfile`:
1313

1414
```
15-
pod 'FirebaseUI', '~> 1.0' # Pull in all Firebase UI features
15+
pod 'FirebaseUI', '~> 0.4' # Pull in all Firebase UI features
1616
```
1717

1818
If you don't want to use all of FirebaseUI, there are multiple subspecs which can selectively install subsets of the full feature set:
1919

2020
```
2121
# Only pull in the "Database" FirebaseUI features
22-
pod 'FirebaseUI/Database', '~> 1.0'
22+
pod 'FirebaseUI/Database', '~> 0.4'
23+
24+
# Only pull in the "Auth" FirebaseUI features (including Facebook and Google)
25+
pod 'FirebaseUI/Auth', '~> 0.4'
26+
27+
# Only pull in the "Facebook" login features
28+
pod 'FirebaseUI/Facebook', '~> 0.4'
29+
30+
# Only pull in the "Google" login features
31+
pod 'FirebaseUI/Google', '~> 0.4'
2332
2433
```
2534

@@ -43,18 +52,17 @@ following commands to get your environment set up:
4352
```bash
4453
$ git clone https://github.com/firebase/FirebaseUI-iOS.git
4554
$ cd FirebaseUI-iOS
46-
$ ./setup.sh
55+
$ pod install
4756
```
4857

49-
Note that `setup.sh` pulls in a number of provider frameworks (Facebook, Google), which need to be pulled in for local development. The debug build and framework release have the flag `LOCAL_BUILD=1` which uses the local frameworks installed via `setup.sh`, while the CocoaPods release doesn't have this flag set, so the appropriate Pod `#import` statements are used.
50-
51-
FirebaseUI makes use of Xcode 7 features such as lightweight generics and `__kindof` annotations, but it should be backwards compatible to Xcode 6 thanks to [XcodeMacros.h](https://github.com/firebase/FirebaseUI-iOS/blob/master/FirebaseUI/XcodeMacros.h).
58+
FirebaseUI makes use of Xcode 7 features such as lightweight generics and
59+
`__kindof` annotations, and is no longer compatible with XCode 6 development.
5260

5361
## Deployment
5462

5563
- `git pull` to update the master branch
5664
- tag and push the tag for this release
57-
- `./build.sh` to build a binary
65+
- `./build_database.sh` to build a database binary (Auth binary steps will be added soon)
5866
- `./create-docs.sh` to generate docs
5967
- From your macbook that already has been granted permissions to FirebaseUI CocoaPods, do `pod trunk push`
6068
- `firebase deploy` the FirebaseUI website with newly generated docs

create-docs.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ appledoc --project-name "FirebaseUI for iOS" \
2929
--output "$DIR/site/" \
3030
--search-undocumented-doc \
3131
--exit-threshold 2 \
32-
"$DIR"/FirebaseUI/**/API/*.h
32+
"$DIR"/FirebaseUI/**/*.h
3333

3434
echo "Copying docs to FirebaseUI site..."
3535
cp -r site/html/* ../FirebaseUI/docs/ios

0 commit comments

Comments
 (0)