diff --git a/.github/workflows/update_readme.py b/.github/workflows/update_readme.py index a414056..46f4954 100644 --- a/.github/workflows/update_readme.py +++ b/.github/workflows/update_readme.py @@ -42,13 +42,50 @@ def returnPercentageOfEachModule(android,ios,shared): open('README.md', 'w').close() f = open('README.md','w') +## In this section I'll write my README.md f.write(f''' # Dev Notary +Dev Notary is a simple application that lets developers create notes, documentations or memos and interact with them. Basic CRUD with addition of sharing the notes with other users. The functional requirements were simple: +- Authentication +- Managing a note: create, read, edit, delete, share +- Restore notes +- List, sort, search -## Kotlin Multiplatform Application +# Application Demo +![Running application](/img/kmm-my-first-take/creating-note.gif) +*Creating notes* + +![Sharing note](/img/kmm-my-first-take/sharing-note.gif) +*Sharing notes* + +# Architecture +Since my stronger side is on Android Development, I've decided to develop this project with common Android pattern, MVVM with clean architecture. With a little help of ViewModel wrapper class on iOS side everything turned out great. + +![Architecture diagram](/img/kmm-my-first-take/architecture.png) + +# Libraries + +### Shared Module: +- Firebase Kotlin SDK +- SQL Delight +- Kodein DI +- Navigation Component +- Multiplatform UUID +- Kotlin Coroutines +- KotlinX Datetime +- Multiplatform Settings +- KotlinX Serialization + +### Android: +- Jetpack Compose +- Accompanist + + ### iOS +- Swift UI + ## Lines of code in each module: ### Android: #### {androidLines} @@ -59,6 +96,5 @@ def returnPercentageOfEachModule(android,ios,shared): ### {percentageComposition} - ''') f.close()