StorageToolKit iOS

StorageToolKit aims to be a set of tools that works together to identify and optimize disk usage.

gojek
19
5
Swift

StorageToolKit

StorageToolKit aims to be a set of tools that works together to identify and optimize disk usage. StorageToolKit Allows Apps to monitor and clean the stored files e.g. cache or other files that an application creates while running.

StorageToolKit contains three libraries as of now:

  • StorageCleaner
  • StorageAnalyzerCore (TBA)
  • StorageAnalyzerUI (TBA)

NOTE: As of now this repo only contains StorageCleaner, we will be soon open sourcing StorageAnalyzerCore & StorageAnalyzerUI.

Installation

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into swift.
To add a package dependency to your Xcode project, select File > Swift Packages > Add Package Dependency and enter below repository URL

https://github.com/gojekfarm/StorageToolKit-iOS

Once you have your Swift package set up, adding StorageToolKit-iOS as a dependency is as easy as adding it to your Package.swift dependencies value.

dependencies: [
    .package(url: "https://github.com/gojekfarm/StorageToolKit-iOS.git", .upToNextMajor(from: "0.9.0"))
]

Cocoapods

CocoaPods is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate pods from StorageToolKit into your Xcode project using CocoaPods, specify the require pod in your Podfile:

StorageCleaner

pod 'StorageCleaner'

Usage

Documentation

  • For StorageCleaner documentation refer StorageCleaner
  • Read the getting started article at here

Contributing

As the creators, and maintainers of this project, we’re glad to invite contributors to help us stay up to date. Please take a moment to review the contributing document in order to make the contribution process easy and effective for everyone involved.

  • If you found a bug, open an issue.
  • If you have a feature request, open an issue.
  • If you want to contribute, submit a pull request.

License

StorageToolKit-iOS is available under the MIT license. See the LICENSE file for more info.