Skip to content

Commit

Permalink
Update update_readme.py
Browse files Browse the repository at this point in the history
  • Loading branch information
solita-michalguspiel authored Jul 22, 2022
1 parent 5019aba commit 04c9046
Showing 1 changed file with 38 additions and 2 deletions.
40 changes: 38 additions & 2 deletions .github/workflows/update_readme.py
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand All @@ -59,6 +96,5 @@ def returnPercentageOfEachModule(android,ios,shared):
### {percentageComposition}
''')
f.close()

0 comments on commit 04c9046

Please sign in to comment.