Skip to content

Commit fe02f72

Browse files
committed
🙌 update readme
1 parent 0a62020 commit fe02f72

File tree

2 files changed

+71
-14
lines changed

2 files changed

+71
-14
lines changed

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 Jonathan Lagneaux
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+50-14
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,58 @@
1-
This is a Kotlin Multiplatform project targeting Android, iOS, Web.
21

3-
* `/composeApp` is for code that will be shared across your Compose Multiplatform applications.
4-
It contains several subfolders:
5-
- `commonMain` 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-
`iosMain` would be the right folder for such calls.
2+
## Badges
93

10-
* `/iosApp` contains iOS applications. Even if you’re sharing your UI with Compose Multiplatform,
11-
you need this entry point for your iOS app. This is also where you should add SwiftUI code for your project.
4+
[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
5+
![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/:user)
126

137

8+
# Composebook 🪄
9+
10+
This is a **Kotlin Multiplatform project** targeting Android, iOS, Web.
11+
12+
[Jetpack Compose Multiplatform](https://www.jetbrains.com/fr-fr/lp/compose-multiplatform/) let us share compose components between mutliples targets such as Android, iOS, Desktop, etc... The new target WASM allow us to now share our component to the web!
13+
14+
**Composebook** is a proof of concept that show how you can use jetpack compose multiplatform to create a **shared component library** for **Android and iOS** while letting you share this library to our beloved designers, collegues etc with **just a [link](https://gosunet.github.io/composebook/)**.
15+
Removing the need to install an app to see those components! A bit like **a storybook for native app** 🙌
16+
17+
18+
19+
## Demo
20+
21+
https://gosunet.github.io/composebook/
22+
23+
24+
## Run Locally
25+
26+
Clone the project
27+
28+
### Run your application on browser
29+
30+
You can open the web application by running the `:composeApp:wasmJsBrowserDevelopmentRun` Gradle task.
31+
32+
33+
### Run your application on Android
34+
35+
- Create an Android virtual device.
36+
- In the list of run configurations, select **composeApp**.
37+
- Choose your Android virtual device and click **Run**.
38+
39+
### Run your application on iOS
40+
41+
- Launch Xcode in a separate window. The first time, you may also need to accept its license terms and allow it to perform some necessary initial tasks.
42+
- In the list of run configurations, select **iosApp** and click **Run**.
43+
- If you don't have an available iOS configuration in the list, add a new iOS simulated device.
44+
## Authors
45+
46+
- [@Gosunet](https://www.github.com/Gosunet)
47+
48+
49+
## Contributing
50+
51+
Contributions are always welcome!
52+
53+
## Appendix
54+
1455
Learn more about [Kotlin Multiplatform](https://www.jetbrains.com/help/kotlin-multiplatform-dev/get-started.html),
1556
[Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform/#compose-multiplatform),
1657
[Kotlin/Wasm](https://kotl.in/wasm/)
1758

18-
**Note:** Compose/Web is Experimental and may be changed at any time. Use it only for evaluation purposes.
19-
We would appreciate your feedback on Compose/Web and Kotlin/Wasm in the public Slack channel [#compose-web](https://slack-chats.kotlinlang.org/c/compose-web).
20-
If you face any issues, please report them on [GitHub](https://github.com/JetBrains/compose-multiplatform/issues).
21-
22-
You can open the web application by running the `:composeApp:wasmJsBrowserDevelopmentRun` Gradle task.

0 commit comments

Comments
 (0)