v1.0

Author: xnth97

README.md

@@ -1,3 +1,66 @@
 # AssetKit
 
-A description of this package.
+A command line tool and Swift package for generating image assets for Apple platforms.
+
+# CLI
+
+## Installation
+
+Please download prebuilt binaries from [Releases](https://github.com/xnth97/AssetKit/releases).
+
+## Usage
+
+The CLI `assetool` supports subcommands for generating both `.appiconset` and `.imageset`. Default subcommand is `icon`.
+
+### Icon
+
+```
+assetool <input> [-o <output>] [-p <platforms>]
+```
+
+`-o, --output <output>`: Path of the output folder. If empty, will use current path of terminal.
+
+`-p, --platforms <platforms>`: Valid values are: `ios`, `iphone`, `ipad`, `mac`, `car`. You can also generate an icon set with multiple platform idioms by sending a string of multiple values separated by comma, e.g. `ios,mac,watch`.
+
+### Image
+
+```
+assetool image <input> [-o <output>] [--width <width>] [--height <height>]
+```
+
+`--width <width>` and `--height <height>`: @1x width or height of the exported image set. If empty, will use the original width/height as @3x size.
+
+# Package
+
+## Installation
+
+```swift
+dependencies: [
+    .package(url: "https://github.com/xnth97/AssetKit", from: "1.0.0"),
+],
+```
+
+## Usage
+
+### Icon
+
+```swift
+AssetKit.generateIconSet(
+    inputPath: input,
+    outputPath: output,
+    platforms: [.ios, .mac])
+```
+
+### Image
+
+```swift
+AssetKit.generateImageSet(
+    inputPath: input,
+    outputPath: output,
+    width: width,
+    height: height)
+```
+
+# License
+
+The project is released under MIT license. Please see [LICENSE](LICENSE) for full terms.

Sources/AssetKit/AssetKit.swift

@@ -20,13 +20,24 @@ public struct AssetKit {
 
     private static let generator = AssetGenerator()
 
+    /// Generates `.imageset` with a given input image.
+    /// - Parameters:
+    ///   - inputPath: Path to input image.
+    ///   - outputPath: Path to output folder.
+    ///   - width: @1x width of output image. If left empty, will use image original size as @3x.
+    ///   - height: @1x height of output image. If let empty, will use image original height as @3x.
     public static func generateImageSet(inputPath: String,
                                         outputPath: String,
                                         width: CGFloat? = nil,
                                         height: CGFloat? = nil) {
         try? generator.generateImageSet(inputPath: inputPath, outputPath: outputPath, width: width, height: height)
     }
 
+    /// Generates `.appiconset` with a given input image.
+    /// - Parameters:
+    ///   - inputPath: Path to input image.
+    ///   - outputPath: Path to output folder.
+    ///   - platforms: Platform idioms that need to be included in the generated icon set.
     public static func generateIconSet(inputPath: String,
                                        outputPath: String,
                                        platforms: [Platform] = [.ios]) {

Sources/assetool/main.swift

@@ -34,7 +34,7 @@ extension Assetool {
 
         static var configuration = CommandConfiguration(
             abstract: "Generates icon set for Apple platforms. Multiple platform idioms can be merged into one single appiconset",
-            discussion: "<platforms> flag: Valid values are: 'ios', 'iphone', 'ipad', 'mac', 'tv', 'car'. To generate an icon set with multiple platform idioms, multiple values should be separated by comma, e.g. 'ios,mac,watch'")
+            discussion: "<platforms> flag: Valid values are: 'ios', 'iphone', 'ipad', 'mac', 'car'. To generate an icon set with multiple platform idioms, multiple values should be separated by comma, e.g. 'ios,mac,watch'")
 
         func run() throws {
             let parsedPlatforms: [AssetKit.Platform] = platforms.split(separator: ",").map { platformStr in