update readme

Author: k-kohey

README.md

@@ -1,21 +1,53 @@
 # Parchment-ios
 
-Parchment is implemention called Logger or Tracker. 
-Parchment has three features:
+This project provides an implementation of a logger that tracks user behavior and system behavior.
+Using this implementation, many logging-related processes can be standardized and hidden.
 
-1. Retrying when logging request is failed.
-2. Log is buffed and can be sent at any time.
-3. Easy to combine your source code and replace logger implemention.
+This is especially useful in the following cases
 
-# [WIP]API Document
+- There are multiple backends sending event logs, and the user wants to control which event logs are sent to which backend.
+- Buffering event logs in local storage to prevent missing event logs
+- To centrally manage parameters that are common to many event logs.
 
-- https://k-kohey.github.io/Parchment-swift/Parchment/documentation/parchment/
-- https://k-kohey.github.io/Parchment-swift/ParchmentDefault/documentation/parchmentdefault/
+Translated with www.DeepL.com/Translator (free version)
 
-# Usage
+## Installation
 
-## 1. Definision logging event
+If you are using Xcode Project, you can add a dependency for this Package by specifying this repository from Xcode.
 
+If you are using the Swift Package Project, you can add a dependency for this Package by adding the following description to Package.swift.
+
+```swift
+dependencies: [
+    .product(name: "Parchment", package: "Parchment"),
+    // The following statements are optional
+    .product(name: "ParchmentDefault", package: "Parchment"),
+]
+```
+
+## Project Overview
+
+### Parchment
+
+It contains the main logic and definitions for logging processing and event logging definitions.
+
+### ParchmentDefault
+
+Provides a stander implementation compliant with the Protocol provided by Parchment. If you implement your own buffer and scheduler, you do not need to add any dependencies.
+
+See the [Customization](#customization) section for more details.
+
+### eventgen
+
+This is an experimental API that generates Swift code from event log specifications written in natural language.
+
+See the [document](EventGen/README.md) section for more details.
+
+## Usage
+
+This section describes the basic usage of this project.
+
+### Definision logging event
 
 ```swift
 
@@ -28,7 +60,7 @@ struct Event: Loggable {
 // with enum
 enum Event: Loggable {
   case impletion(screen: String)
-  
+
   var eventName: String {
     ...
   }
@@ -45,7 +77,7 @@ Alternatively, there are two ways to do this without definision logging event.
 - Use type `TrackingEvent`
 - Use Dictionary. Dictionary is conformed Loggable.
 
-## 2. Wrap logging service
+### Wrap logging service
 
 Wrap existing logger implemention such as such as FirebaseAnalytics and endpoints with LoggerComponent.
 
@@ -61,7 +93,7 @@ struct Analytics: LoggerComponent {
     func send(_ event: Loggable) async -> Bool {
         let url = URL(string: "https://your-endpoint/...")!
         request.httpBody = convertBody(from: event)
-        
+
         return await withCheckedContinuation { continuation in
             let task = URLSession.shared.dataTask(with: request) { data, response, error in
 
@@ -70,15 +102,15 @@ struct Analytics: LoggerComponent {
                     continuation.resume(returning: false)
                     return
                 }
-                
+
                 guard
                     let response = response as? HTTPURLResponse,
                     (200..<300).contains(response.statusCode)
                 else {
                     continuation.resume(returning: false)
                     return
                 }
-                
+
                 continuation.resume(returning: true)
             }
             task.resume()
@@ -88,7 +120,7 @@ struct Analytics: LoggerComponent {
 
 ```
 
-## 3. Send event
+### Send event
 
 Initialize `LoggerBundler` and send log using it.
 
@@ -108,13 +140,20 @@ await logger.send([\.eventName: "tapButton", \.parameters: ["ButtonID": 1]])
 
 ```
 
-# Customization
+### More Information
+
+Please see the API documentation below（WIP）.
+
+- https://k-kohey.github.io/Parchment-swift/Parchment/documentation/parchment/
+- https://k-kohey.github.io/Parchment-swift/ParchmentDefault/documentation/parchmentdefault/
+
+## Customization
 
 This section describes how to customize the behavior of the logger.
 
-## Create a type that conforms to Mutation
+### Create a type that conforms to Mutation
 
-Mutation converts one log into another. 
+Mutation converts one log into another.
 
 This is useful if you have parameters that you want to add to all the logs.
 
@@ -130,7 +169,7 @@ struct DeviceDataMutation: Mutation {
         "OS": UIDevice.current.systemName,
         "OS Version": UIDevice.current.systemVersion
     ]
-    
+
     public func transform(_ event: Loggable, id: LoggerComponentID) -> Loggable {
         let log: LoggableDictonary = [
             \.eventName: event.eventName,
@@ -144,13 +183,12 @@ logger.mutations.append(DeviceDataMutation())
 
 ```
 
-## Extend LoggerComponentID
+### Extend LoggerComponentID
 
 LoggerComponentID is an ID that uniquely recognizes a logger.
 
 By extending LoggerComponentID, the destination of the log can be controlled as shown below.
 
-
 ```swift
 
 extension LoggerComponentID {
@@ -164,30 +202,29 @@ await logger.send(.tap, with: .init(scope: .only([.myBadkend])))
 
 ```
 
-## Create a type that conforms to BufferedEventFlushScheduler
+### Create a type that conforms to BufferedEventFlushScheduler
 
 BufferedEventFlushScheduler determines the timing of fetching the log data in the buffer.
 To create the type and set it to logger, write as follows.
 
-
 ```swift
 
 // An implementation similar to this can be found in ParchmentDefault
 final class RegularlyPollingScheduler: BufferedEventFlushScheduler {
     public static let `default` = RegularlyPollingScheduler(timeInterval: 60)
-    
+
     let timeInterval: TimeInterval
-    
+
     var lastFlushedDate: Date = Date()
-    
+
     private weak var timer: Timer?
-    
+
     public init(
         timeInterval: TimeInterval,
     ) {
         self.timeInterval = timeInterval
     }
-    
+
     public func schedule(with buffer: TrackingEventBufferAdapter) async -> AsyncThrowingStream<[BufferRecord], Error> {
         return AsyncThrowingStream { continuation in
             let timer = Timer(fire: .init(), interval: 1, repeats: true) { _ in
@@ -201,19 +238,19 @@ final class RegularlyPollingScheduler: BufferedEventFlushScheduler {
             self.timer = timer
         }
     }
-    
+
     public func cancel() {
         timer?.invalidate()
     }
-    
+
     private func tick(with buffer: TrackingEventBufferAdapter, didFlush: @escaping ([BufferRecord])->()) async {
         guard await buffer.count() > 0 else { return }
-        
+
         let flush = {
             let records = await buffer.load()
             didFlush(records)
         }
-        
+
         let timeSinceLastFlush = abs(self.lastFlushedDate.timeIntervalSinceNow)
         if self.timeInterval < timeSinceLastFlush {
             await flush()
@@ -231,7 +268,7 @@ let logger = LoggerBundler(
 
 ```
 
-## Create a type that conforms to TrackingEventBuffer
+### Create a type that conforms to TrackingEventBuffer
 
 TrackingEventBuffer is a buffer that saves the log.