fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnell# ForgeRock Authenticator for iOS
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnellThe ForgeRock Authenticator provides a secure method for users to access their
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnellaccounts managed by ForgeRock's OpenAM.
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnellThis works in combination with OpenAM's "ForgeRock Authenticator (OATH)" and
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnell"ForgeRock Authenticator (Push)" authentication modules.
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnell## Getting Started
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnell* Download the project's code (`git clone ...`)
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnell* Download dependencies defined in the [CocoaPods](https://cocoapods.org/) [Podfile](Podfile) - You'll need to [install CocoaPods](https://guides.cocoapods.org/using/getting-started.html) and run the command `pod install`
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnell* Open the project in Xcode (`open ForgeRock.xcworkspace/`)
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnellCheck Confluence for [further information relating to this project](https://wikis.forgerock.org/confluence/display/openam/ForgeRock+Authenticator+Apps).
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnellAs implied in the Getting Started instructions above, this project uses CocoaPods
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnellfor managing 3rd party dependencies. Further details regarding CocoaPods can be
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnellfound [online](https://guides.cocoapods.org).
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnellAfter adding new dependencies to the [Podfile](Podfile), run `pod install` to
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnelldownload the dependency and capture its version in the [Podfile.lock](Podfile.lock)
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnellfile. The [Podfile.lock](Podfile.lock) file ensures that running `pod install`
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnellagain will download the same versions.
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnellUpdating to a newer version of a dependency can be achieved by using a combination
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnellof `pod outdated` to identify dependencies that are outdated and `pod update` to
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnellupdate them. See [CocoaPods install vs update documentation](https://guides.cocoapods.org/using/pod-install-vs-update.html)
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnellfor further details.
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnellWhen adding, removing or updating 3rd party dependencies, be sure to update the
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnell[LIBRARIES](LIBRARIES) file.
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnellWe use [Typhoon](http://typhoonframework.org/) for dependency injection.
fb63998ce7684bddab24e10c0b593809df1b7bffCraig McDonnellDependencies are defined in [FRAApplicationAssembly.h](ForgeRock-Authenticator/FRAApplicationAssembly.h).