README.md

TCALogsSheetKit

Table of contents

1. Introduction
2. Usage
3. Installation
4. Contribution
5. Maintainers

Introduction

Lightweight customizable logger for iOS using Swift 5.7, with minimum iOS 14 version for TCA

Usage

Usage of TCALogsSheetKit is pretty straight-forward, since TCALogsSheetKit handles most of the work by itself.

In order to log any message, just add .log(isDebug: ) under your reducer.

  }
  .log(isDebug: true)

You also can add custom message if you want by simply doing:

  }
  .log(isDebug: true) { action in
    return "Riiid with \(action)"
  }

In order to open LogsSheetView, just present LogsSheet(), and that's it!

Installation

Riiid's LogsSheetKit can be installed through Swift Package Manager easily and with comfort.

let package = Package(
  name: "MyPackage",
  dependencies: [
    .package(url: "https://github.com/riiid/TCALogsSheetKit.git", .upToNextMajor(from: "1.0.0"))
  ],
  targets: [
    .target(name: "MyTarget", dependencies: ["TCALogsSheetKit"])
  ]
)

Contribution

Any discussion and or pull requests are welcome!

In order to contribute, please subbranch from main, and after finishing the work open PR to main branch. Please note that PR should be reviewed by 2 people from code owners!

Please provide as much information about your proposed changes as possible.

License

TCALogsSheetKit is under MIT license. See the LICENSE for more info.