diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c4e851..2e21174 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,11 @@ # Contributing +- If you **need help**, use [Stack Overflow](http://stackoverflow.com/questions/tagged/snapkit). (Tag 'snapkit') +- If you'd like to **ask a general question**, use [Stack Overflow](http://stackoverflow.com/questions/tagged/snapkit). +- 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. + ### Pull Requests We gladly accept any PR's assuming they are well written, documented ( if necessary ) and preferably have test code. If you're unsure if we'll accept a new feature please open an issue requesting it and we can have a discussion before you code and submit a PR. diff --git a/README.md b/README.md index e419447..0e5ac50 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,11 @@ SnapKit is a DSL to make Auto Layout easy on both iOS and OS X. [![Cocoapods Compatible](https://img.shields.io/cocoapods/v/SnapKit.svg)](https://cocoapods.org/pods/SnapKit) [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) +#### ⚠️ **To use with Swift 2.x please ensure you are using == 0.22.0** ⚠️ +#### ⚠️ **To use with Swift 3.x please ensure you are using >= 3.0.0** ⚠️ + +## Contents + - [Requirements](#requirements) - [Migration Guides](#migration-guides) - [Communication](#communication) @@ -17,7 +22,7 @@ SnapKit is a DSL to make Auto Layout easy on both iOS and OS X. ## Requirements -- iOS 9.0+ / Mac OS X 10.11+ / tvOS 9.0+ +- iOS 8.0+ / Mac OS X 10.11+ / tvOS 9.0+ - Xcode 8.0+ - Swift 3.0+