Skip to content

Commit 9c55106

Browse files
committed
grpc: Adjust demo README.md
1 parent 78176d6 commit 9c55106

File tree

1 file changed

+7
-16
lines changed

1 file changed

+7
-16
lines changed

samples/grpc-kmp-app/README.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,13 @@
1-
This is a Kotlin Multiplatform project targeting iOS, Desktop (JVM), Server.
1+
This is a Kotlin Multiplatform project targeting iOS, Desktop (JVM), Server, demonstrating the `kotlinx.rpc` library
2+
for gRPC.
23

3-
* [/composeApp](./composeApp/src) is for code that will be shared across your Compose Multiplatform applications.
4-
It contains several subfolders:
5-
- [commonMain](./composeApp/src/commonMain/kotlin) is for code that’s common for all targets.
6-
- Other folders are for Kotlin code that will be compiled for only the platform indicated in the folder name.
7-
For example, if you want to use Apple’s CoreCrypto for the iOS part of your Kotlin app,
8-
the [iosMain](./composeApp/src/iosMain/kotlin) folder would be the right place for such calls.
9-
Similarly, if you want to edit the Desktop (JVM) specific part, the [jvmMain](./composeApp/src/jvmMain/kotlin)
10-
folder is the appropriate location.
4+
* [/composeApp](./composeApp/src) is for code that will be shared across Compose Multiplatform applications.
5+
- [commonMain](./composeApp/src/commonMain/kotlin) contains all the relevant gRPC client application code for all platforms.
116

12-
* [/iosApp](./iosApp/iosApp) contains iOS applications. Even if you’re sharing your UI with Compose Multiplatform,
13-
you need this entry point for your iOS app. This is also where you should add SwiftUI code for your project.
14-
15-
* [/server](./server/src/main/kotlin) is for the Ktor server application.
7+
* [/server](./server/src/main/kotlin) is for the gRPC server application.
168

179
* [/shared](./shared/src) is for the code that will be shared between all targets in the project.
18-
The most important subfolder is [commonMain](./shared/src/commonMain/kotlin). If preferred, you
19-
can add code to the platform-specific folders here too.
10+
It contains the proto files and the generated code used by both, the server and the client applications.
2011

2112
### Build and Run Desktop (JVM) Application
2213

@@ -33,7 +24,7 @@ in your IDE’s toolbar or run it directly from the terminal:
3324

3425
### Build and Run Server
3526

36-
To build and run the development version of the server, use the run configuration from the run widget
27+
To build and run the server, use the run configuration from the run widget
3728
in your IDE’s toolbar or run it directly from the terminal:
3829
- on macOS/Linux
3930
```shell

0 commit comments

Comments
 (0)