Fill in README

README.md

@@ -1 +1,45 @@
-# Require
+# Require
+
+Easily require an `Optional` value to be non-`nil`, and crash gracefully if that's false.
+
+Sometimes you have optional values in your code that are not really optional, and will cause your
+application to enter an undefined state if `nil`. Require makes it easy to avoid such states, by
+causing a crash with rich debug information, to enable you to much easier hunt down & fix the bug.
+
+## Usage
+
+Call `require()` on any `Optional`, optionally giving a `hint` for debugging purposes:
+
+```swift
+class ConfigurationLoader {
+    func load() -> Configuration {
+        let data = readJSONFile().require(hint: "Verify that Config.JSON is valid")
+        let config: Configuration? = try? unbox(data: data)
+        return config.require()
+    }
+}
+```
+
+## Installation
+
+**Swift Package Manager:**
+
+Add `.Package(url: "[email protected]:johnsundell/require.git", majorVersion: 1)` to your `Package.swift` file.
+
+**CocoaPods:**
+
+Add `pod "Require"` to your `Podfile`.
+
+**Carthage:**
+
+Add `github "johnsundell/require"` to your `Cartfile`.
+
+**Manual:**
+
+Clone the repo and drag the file `Require.swift` into your Xcode project.
+
+## Help, feedback or suggestions?
+
+- [Open an issue](https://github.com/JohnSundell/Require/issues/new) if you need help, if you found a bug, or if you want to discuss a feature request.
+- [Open a PR](https://github.com/JohnSundell/Require/pull/new/master) if you want to make some change to Require.
+- Contact [@johnsundell on Twitter](https://twitter.com/johnsundell) for discussions, news & announcements about Require.