Skip to content

Commit

Permalink
Readme and license
Browse files Browse the repository at this point in the history
  • Loading branch information
onevcat committed Dec 24, 2015
1 parent bc45b89 commit b2e7d5c
Show file tree
Hide file tree
Showing 2 changed files with 128 additions and 0 deletions.
22 changes: 22 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
The MIT License (MIT)

Copyright (c) 2015 Wei Wang

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

106 changes: 106 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
![Rainbow](https://raw.githubusercontent.com/onevcat/Rainbow/assets/rainbow.png)

**`Rainbow` is a framework under developing, It is not released now. Do not use it yet.**

`Rainbow` adds methods to set text color, background color and style for Swift
console and command line output, for both OS X and Linux. It is also compatible
with [XcodeColors](https://github.com/robbiehanson/XcodeColors), so you could
use it in your Xcode to colorize the debugger output as well.

## Usage

Nifty way, using the `String` extension:

```swift
import Rainbow

print("Red text".red)
print("Yellow background".onYellow)
print("Light green text on white background".lightGreen.onWhite)

print("Underline".underline)
print("Cyan with bold and blinking".cyan.bold.blink)

print("Plain text".red.onYellow.bold.clearColor.clearBackgroundColor.clearStyles)
```

You can also use the more verbose way if you need:

```swift
import Rainbow
let output = "The quick brown fox jumps over the lazy dog"
.stringByApplying([Color.Red, BackgroundColor.Yellow, Style.Bold])
print(output) // Red text on yellow, bold of course :)
```

## Motivation and Compatibility

Thanks to the open source of Swift, developers now could write cross platform
programs with the same language. And I believe the command line tool would be
the next great platform for Swift. Colorful and well organized output helps us
to understand what happens and it could be a necessary utility to create
wonderful software.

`Rainbow` should work well in both OS X and Linux terminals. It will also check
whether the output is a valid text terminal or not, to decide which to log.
It could be useful when you want to log to a file instead to terminals.

Although `Rainbow` is first designed for console output in terminals, you could
use it in Xcode with [XcodeColors](https://github.com/robbiehanson/XcodeColors)
plugin installed too. It will enable color output for better debugging experience.

## Install

### Swift Package Manager

If you are developing a cross platform software in Swift,
[Swift Package Manager](https://github.com/apple/swift-package-manager) might
be your choice for package management. Just add the url of this repo to your
`Package.swift` file as a dependency:

```swift
import PackageDescription

let package = Package(
name: "YourAwesomeSoftware",
dependencies: [
.Package(url: "https://github.com/onevcat/Rainbow",
majorVersion: 1),
]
)
```

Then run `swift build` whenever you get prepared.

You could know more information on how to use Swift Package Manager
in Apple's [official page](https://swift.org/package-manager/).

### CocoaPods

Not supported yet.

### Carthage

[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency
manager for Cocoa application.

To integrate `Rainbow` with Carthage, add this to your `Cartfile`:

```ruby
github "onevcat/Rainbow" ~> 1.0
```

Run `carthage update` to build the framework and drag the built
`Rainbow.framework` into your Xcode project (as well as embed it in your target
if necessary).

## Contact

Follow and contact me on [Twitter](http://twitter.com/onevcat) or
[Sina Weibo](http://weibo.com/onevcat). If you find an issue,
just [open a ticket](https://github.com/onevcat/Rainbow/issues/new) on it. Pull
requests are warmly welcome as well.

## License

Rainbow is released under the MIT license. See LICENSE for details.

0 comments on commit b2e7d5c

Please sign in to comment.