Skip to content
This repository has been archived by the owner on Oct 11, 2024. It is now read-only.

Commit

Permalink
Add versioning section to iOS docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Bruno Farache committed Mar 19, 2014
1 parent 25a4648 commit be76d58
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ you to download and use.

If all you want is to access Liferay's core services from a mobile app, follow
the links above. However, if you want to generate services for your custom
portlet, read the [SDK Builder documentation](builder/README.md).
portlet, read the [SDK Builder documentation](builder/README.md).
22 changes: 22 additions & 0 deletions ios/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
* [Setup](#setup)
* [Manually](#manually)
* [CocoaPods](#cocoapods)
* [Versioning](#versioning)
* [Use](#use)
* [Asynchronous](#asynchronous)
* [Batch](#batch)
Expand Down Expand Up @@ -51,6 +52,27 @@ file, use that file to open your project in XCode.
For more information on how CocoaPods works, read their
[documentation](http://guides.cocoapods.org/using/index.html).

### Versioning

Each Liferay Mobile SDK is designed to work with a specific Liferay Portal
version. Because of that, its version scheme reflects the compatible Liferay
version.

For example, Liferay Mobile SDK 6.2.0.1 is built to work with Liferay Portal
6.2.0, while Liferay Mobile SDK 7.0.0.1 works with Liferay Portal 7.0.0.

The fourth integer in the version (6.2.0.x) is related to internal Liferay
Mobile SDK versions. For example, if a bug is found on 6.2.0.1, we will
release a version called 6.2.0.2 with the bug fix.

This doesn't mean you can't support several Liferay versions in the same
app though. You can add to your project both versions 6.2.0.1 and 7.0.0.1.
There won't be conflicts because service classes names are prefixed with
their version number as well: *_v62.m, *_v7.m, etc.

To find out which Liferay versions you are connecting to, use the
`[LRHttpUtil getPortalVersion:…]` method.

### Use

1. Create a `Session` with the user credentials:
Expand Down

0 comments on commit be76d58

Please sign in to comment.