README update (#17)

* README update

* README update

* added link to LS 0.1.0 release note

Author: jeffxtang

README.md

@@ -4,19 +4,24 @@
 
 llama-stack-client-swift brings the inference and agents APIs of [Llama Stack](https://github.com/meta-llama/llama-stack) to iOS.
 
+**Update: January 27, 2025** The llama-stack-client-swift SDK version has been updated to 0.1.0, working with Llama Stack 0.1.0 ([release note](https://github.com/meta-llama/llama-stack/releases/tag/v0.1.0)).
+
 ## Features
 
 - **Inference & Agents:** Leverage remote Llama Stack distributions for inference, code execution, and safety.
 - **Custom Tool Calling:**  Provide Swift tools that Llama agents can understand and use.
 
-## Quick Demo
-See [here](https://github.com/meta-llama/llama-stack-apps/tree/ios_demo/examples/ios_quick_demo/iOSQuickDemo) for a complete iOS demo ([video](https://drive.google.com/file/d/1HnME3VmsYlyeFgsIOMlxZy5c8S2xP4r4/view?usp=sharing)) using a remote Llama Stack server for inferencing.
+## iOS Demos
+See [here](https://github.com/meta-llama/llama-stack-apps/tree/main/examples/ios_quick_demo) for a quick iOS demo ([video](https://drive.google.com/file/d/1HnME3VmsYlyeFgsIOMlxZy5c8S2xP4r4/view?usp=sharing)) using a remote Llama Stack server for inferencing.
+
+For a more advanced demo using the Llama Stack Agent API and custom tool calling feature, see the [iOS Calendar Assistant demo](https://github.com/meta-llama/llama-stack-apps/tree/main/examples/ios_calendar_assistant).
+
 
 ## Installation
 
 1. Click "Xcode > File > Add Package Dependencies...".
 
-2. Add this repo URL at the top right: `https://github.com/meta-llama/llama-stack-client-swift`.
+2. Add this repo URL at the top right: `https://github.com/meta-llama/llama-stack-client-swift` and 0.1.0 in the Dependency Rule, then click Add Package.
 
 3. Select and add `llama-stack-client-swift` to your app target.
 
@@ -27,68 +32,65 @@ See [here](https://github.com/meta-llama/llama-stack-apps/tree/ios_demo/examples
 ```
 conda create -n llama-stack python=3.10
 conda activate llama-stack
-pip install llama-stack=0.1.0
+pip install --no-cache llama-stack==0.1.0 llama-models==0.1.0 llama-stack-client==0.1.0
 ```
+
 Then, either:
 ```
-llama stack build --template fireworks --image-type conda
+PYPI_VERSION=0.1.0 llama stack build --template fireworks --image-type conda
 export FIREWORKS_API_KEY="<your_fireworks_api_key>"
 llama stack run fireworks
 ```
 or
 ```
-llama stack build --template together --image-type conda
+PYPI_VERSION=0.1.0 llama stack build --template together --image-type conda
 export TOGETHER_API_KEY="<your_together_api_key>"
 llama stack run together
 ```
 
 The default port is 5000 for `llama stack run` and you can specify a different port by adding `--port <your_port>` to the end of `llama stack run fireworks|together`.
 
-6. Replace the `RemoteInference` url below with the your host IP and port:
+6. Replace the `RemoteInference` url string below with the host IP and port of the remote Llama Stack distro in Step 5:
 
 ```swift
 import LlamaStackClient
 
 let inference = RemoteInference(url: URL(string: "http://127.0.0.1:5000")!)
+```
+Below is an example code snippet to use the Llama Stack inference API. See the iOS Demos above for complete code.
 
-do {
-    for await chunk in try await inference.chatCompletion(
+```swift
+for await chunk in try await inference.chatCompletion(
     request:
         Components.Schemas.ChatCompletionRequest(
         messages: [
-            .UserMessage(Components.Schemas.UserMessage(
-            content: .case1(userInput),
-            role: .user)
+            .user(
+            Components.Schemas.UserMessage(
+                content:
+                    .InterleavedContentItem(
+                        .text(Components.Schemas.TextContentItem(
+                            text: userInput,
+                            _type: .text
+                        )
+                    )
+                ),
+                role: .user
             )
-        ], model_id: "meta-llama/Llama-3.1-8B-Instruct",
+        )
+        ],
+        model_id: "meta-llama/Llama-3.1-8B-Instruct",
         stream: true)
     ) {
         switch (chunk.event.delta) {
-        case .TextDelta(let s):
-            print(s.text)
-            break
-        case .ImageDelta(let s):
-            print("> \(s)")
-            break
-        case .ToolCallDelta(let s):
-            print("> \(s)")
-            break
+            case .text(let s):
+                message += s.text
+                break
+            case .image(let s):
+                print("> \(s)")
+                break
+            case .tool_call(let s):
+                print("> \(s)")
+                break
         }
     }
-}
-catch {
-    print("Error: \(error)")
-}
 ```
-
-### Syncing the API spec
-
-Llama Stack `Types.swift` file is generated from the Llama Stack [API spec](https://github.com/meta-llama/llama-stack/blob/main/docs/resources/llama-stack-spec.yaml) in the main [Llama Stack repo](https://github.com/meta-llama/llama-stack).
-
-```
-scripts/generate_swift_types.sh
-```
-
-By default, this script will download the latest API spec from the main branch of the Llama Stack repo. You can set `LLAMA_STACK_DIR` to a local Llama Stack repo to use a local copy of the API spec instead.
-
-This will update the `openapi.yaml` file in the Llama Stack Swift SDK source folder `Sources/LlamaStackClient`.