refactor: README

ochairo · Mar 24, 2024 · 97ad992 · 97ad992
1 parent 346f1f8
commit 97ad992
Showing 1 changed file with 30 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -33,40 +33,40 @@ the concepts themselves are complex and hard to understand.
 ## Directory structure
 
 ```sh
-├── docs                              // Documentation files
-│   ├── images                        // Image resources
-│   └── wiki                          // Wiki pages
+├── docs                              # Documentation files
+│   ├── images                        # - Image resources
+│   └── wiki                          # - Wiki pages
 │
-├── scripts                           // Shell scripts
-│   └── onboarding                    // Onboarding scripts
+├── scripts                           # Shell scripts
+│   └── onboarding                    # - Onboarding scripts
 │
-└── src                               // Source code
-    ├── app                           // Application code
-    │   ├── shared                    // Shared components and utilities
-    │   │   ├── router                // Router configurations
-    │   │   ├── styles                // Shared stylesheets
-    │   │   └── ui-components         // Reusable UI components
-    │   │       ├── atoms             // Basic UI elements
-    │   │       ├── molecules         // Simple component compositions
-    │   │       └── organisms         // Complex UI components
-    │   ├── features                  // Feature-specific code
-    │   │   └── ${feature name}       // Individual features
-    │   │       ├── data              // Data-related modules
-    │   │       │   ├── datasources   // Data sources
-    │   │       │   └── repositories  // Data repositories
-    │   │       ├── domain            // Domain logic
-    │   │       └── presentation      // Presentation components
-    │   ├── main.html                 // Main HTML file
-    │   ├── main.ts                   // Main TypeScript file
-    │   └── routes.ts                 // Routing configuration
+└── src
+    ├── app                           # Application code
+    │   ├── shared                    # - Shared components and utilities
+    │   │   ├── router                # - Router configurations
+    │   │   ├── styles                # - Shared stylesheets
+    │   │   └── ui-components         # - Reusable UI components
+    │   │       ├── atoms             # - Basic UI elements
+    │   │       ├── molecules         # - Simple component compositions
+    │   │       └── organisms         # - Complex UI components
+    │   ├── features                  # - Feature-specific code
+    │   │   └── ${feature name}       # - Individual features
+    │   │       ├── data              # - Data-related modules
+    │   │       │   ├── datasources   # - Data sources
+    │   │       │   └── repositories  # - Data repositories
+    │   │       ├── domain            # - Domain logic
+    │   │       └── presentation      # - Presentation components
+    │   ├── main.html                 # - Main HTML file
+    │   ├── main.ts                   # - Main TypeScript file
+    │   └── routes.ts                 # - Routing configuration
     │
-    ├── mock                          // Mock data and server
-    │   ├── data                      // Mock data files
-    │   └── server                    // Mock server files
+    ├── mock                          # Mock data and server
+    │   ├── data                      # - Mock data files
+    │   └── server                    # - Mock server files
     │
-    └── test                          // Test files
-        ├── e2e                       // End-to-end tests
-        └── unit                      // Unit tests
+    └── test                          # Test files
+        ├── e2e                       # - End-to-end tests
+        └── unit                      # - Unit tests
 ```
 
 ## Onboarding setup