kylefang/realm-cocoa

mirror of https://github.com/HackPlan/realm-cocoa.git synced 2026-01-12 22:44:39 +08:00

Files

History

JP Simard ae2a0ddef3 remove trailing '/' from link tags in custom_head.html

2016-01-04 16:36:33 -08:00

..

custom_head.html

remove trailing '/' from link tags in custom_head.html

2016-01-04 16:36:33 -08:00

README.md

rewrite docs/README.md as it was completely out of date

2015-11-10 15:57:21 -08:00

README.md

Documentation

Realm Objective-C

The documentation can be found at realm.io/docs/objc/latest.
The API reference is located at realm.io/docs/objc/latest/api.

Realm Swift

The documentation can be found at realm.io/docs/swift/latest.
The API reference is located at realm.io/docs/swift/latest/api.

Generating Docs

You can generate the API docs locally by running sh build.sh docs from the root of this repository. This requires installation of jazzy. You will find the output in docs/swift_output/ and docs/objc_output/.