Merge pull request #72 from RotBolt/task/update-docs-information

Update docs for flaker-android v0.1.0

README.md

@@ -18,12 +18,20 @@ https://github.com/RotBolt/Flaker/assets/24780524/3d00e644-0f47-4755-8402-74001f
 
 ## Getting Started
 
-### Usage
+#### Installation (In Progress - Not yet published to maven central)
+
+Add the following dependency to your project.
+
+```kotlin
+    debugImplementation("io.rotlabs:flaker-android-okhttp:${latest_version}")
+    releaseImplementation("io.rotlabs:flaker-android-okhttp-no-op:${latest_version}")
+```
+
+**_NOTE:_** It is not yet published to maven central. But you can download all the modules from [github packages](https://github.com/RotBolt?tab=packages&repo_name=Flaker) and add them to your project for now.
 
 #### flaker-android-okhttp
 Add the following statement to your app's onCreate method.
-```kotlin   
-
+```kotlin
    class MainApplication: Application() {
        override fun onCreate() {
            super.onCreate()
@@ -39,12 +47,17 @@ Then in your okhttp client builder, add the following interceptor.
         .build()
 ```
 
+#### flaker-android-ktor (In Progress)
+
+#### flaker-ios-ktor (In Progress)
+
 That's it. Now you can use the companion app to simulate the network conditions.
 
 ## Development
 
 ### Library Code Map
-![library-code-map.png](docs/assets/library-code-map.png)
+![library-code-map.png](docs/assets/library-code-map.png#gh-light-mode-only)
+![library-code-map.png](docs/assets/library-code-map-dark.png#gh-dark-mode-only)
 
 
 ### :hammer: Build

docs/development.md

@@ -1,10 +1,12 @@
 ## Development
 
 ### Library Code Map
-![library-code-map.png](assets/library-code-map.png)
+### Library Code Map
+![library-code-map.png](assets/library-code-map.png#only-light)
+![library-code-map.png](assets/library-code-map-dark.png#only-dark)
 
 
-### 🛠️ Build
+### Build
 Simply clone this repository in Android Studio Giraffe or above and build the project.
 
 ### Module Details

docs/getting-started.md

@@ -1,9 +1,19 @@
 # Usage
 
+#### Installation (In Progress - Not yet published to maven central)
+
+Add the following dependency to your project.
+
+```kotlin
+    debugImplementation("io.rotlabs:flaker-android-okhttp:${latest_version}")
+    releaseImplementation("io.rotlabs:flaker-android-okhttp-no-op:${latest_version}")
+```
+
+**_NOTE:_** It is not yet published to maven central. But you can download all the modules from [github packages](https://github.com/RotBolt?tab=packages&repo_name=Flaker) and add them to your project for now.
+
 #### flaker-android-okhttp
 Add the following statement to your app's onCreate method.
-```kotlin   
-
+```kotlin
    class MainApplication: Application() {
        override fun onCreate() {
            super.onCreate()
@@ -19,4 +29,8 @@ Then in your okhttp client builder, add the following interceptor.
         .build()
 ```
 
+#### flaker-android-ktor (In Progress)
+
+#### flaker-ios-ktor (In Progress)
+
 That's it. Now you can use the companion app to simulate the network conditions.

mkdocs.yml

@@ -11,13 +11,25 @@ nav:
   - Development: development.md
 theme:
   name: 'material'
-  logo: 'assets/logo.png'
-  icon:
-    repo: fontawesome/brands/github
-  favicon: 'assets/logo.png'
+  favicon: assets/images/icon-square.png
+  logo: assets/logo.png
   palette:
-    primary: 'deep-orange'
-    accent: 'deep-purple'
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: teal
+      accent: blue
+      toggle:
+        icon: octicons/sun-24
+        name: "Switch to Dark Mode"
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: teal
+      accent: blue
+      toggle:
+        icon: octicons/moon-24
+        name: "Switch to Light Mode"
+  features:
+    - navigation.tabs
 markdown_extensions:
   - attr_list
   - md_in_html