Skip to content

Commit

Permalink
Update README.md for 2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
sharplet committed Mar 29, 2019
1 parent 64385f3 commit 3bf30ed
Showing 1 changed file with 15 additions and 29 deletions.
44 changes: 15 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,30 +131,18 @@ let possibleEndings = Regex("it's gonna (.+)")

## Installation

Regex supports Swift 4.2 and above, on all Swift platforms.

#### Swift Package Manager

Add a dependency to your `Package.swift`:

```swift
// Swift 4

let package = Package(
name: "MyPackage",
dependencies: [
// other dependencies...
.package(url: "https://github.com/sharplet/Regex.git", from: "1.1.0"),
]
)
```

```swift
// Swift 3

let package = Package(
name: "MyPackage",
dependencies: [
// other dependencies...
.Package(url: "https://github.com/sharplet/Regex.git", majorVersion: 1, minor: 1),
.package(url: "https://github.com/sharplet/Regex.git", from: "2.0.0"),
]
)
```
Expand All @@ -164,15 +152,15 @@ let package = Package(
Put this in your Cartfile:

```
github "sharplet/Regex" ~> 1.1
github "sharplet/Regex" ~> 2.0
```

#### CocoaPods

Put this in your Podfile:

```ruby
pod "STRegex", "~> 1.1"
pod "STRegex", "~> 2.0"
```


Expand Down Expand Up @@ -206,14 +194,7 @@ rake docker

And run the tests via Swift Package Manager.

### Carthage & Xcode

Install Carthage via Homebrew and build the dependencies:

```
brew install carthage
rake setup
```
### Xcode

`xcpretty` is recommended, for prettifying test output:

Expand All @@ -230,16 +211,21 @@ rake test:ios
rake test:tvos
```

### Linting
### Formatting & Linting

Regex uses [SwiftFormat](https://github.com/nicklockwood/SwiftFormat) to
maintain consistent code formatting.

Regex uses [SwiftLint](https://github.com/realm/SwiftLint) to validate code style.
SwiftLint is automatically run against pull requests using [Hound CI](https://houndci.com/).

You can also run it locally:
When submitting a pull request, running these tools and addressing any issues
is much appreciated!

```
$ brew install swiftlint
$ rake swiftlint
brew bundle
swiftformat .
swiftlint
```


Expand Down

0 comments on commit 3bf30ed

Please sign in to comment.