Merge pull request #10 from jjotaum/feature/swift-package-manager-sup…

…port-part-two

Swift Package Manager Support Part Two

.gitignore

@@ -39,6 +39,5 @@ Package.resolved
 
 # Xcode automatically generates this directory with a .xcworkspacedata file and xcuserdata
 # hence it is not needed unless you have added a package configuration file to your project
-# .swiftpm
-
+.swiftpm
 .build/

README.md

@@ -1,3 +1,44 @@
 # Chroma
 
 A command line tool to generate swift colors definitions from .xcassets files.
+
+### Usage
+
+```
+$ Chroma --help
+
+USAGE: generator [--name <name>] [--output <output>] [--platform <platform>]
+
+OPTIONS:
+  -n, --name <name>       Defines the name of the generated file. (default:
+                          Chroma)
+  -o, --output <output>   Specifies generated file type.
+                          Supported values: "extension","struct". (default:
+                          extension)
+  -p, --platform <platform>
+                          Specifies the platform compatibility of the exported
+                          file. (default: iOS)
+  -h, --help              Show help information.
+```
+
+### Installation
+
+Clone Chroma on your machine:
+
+```
+$ git clone https://github.com/jjotaum/Chroma.git
+```
+Navigate to it's directory:
+
+```
+$ cd Chroma
+```
+
+Execute install script
+```
+$ ./install.sh
+```
+Chroma should now be installed on /usr/local/bin and can be accessed via terminal.
+```
+$ chroma
+```

install.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+swift package clean
+swift test
+swift build -c release
+cp .build/release/Chroma /usr/local/bin/chroma