Readme

pvzig · Mar 6, 2019 · bde39be · bde39be
1 parent 5d7ac48
commit bde39be
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 23 deletions.
diff --git a/SKClient/README.md b/SKClient/README.md
@@ -5,7 +5,7 @@ Create a custom SlackKit client.
 
 <details>
   <summary><strong>Swift Package Manager</strong></summary>
-Add SlackKit as a dependency to your `Package.swift` and specify `SKClient` as a target dependency:
+Add SlackKit as a dependency to your <code>Package.swift</code> and specify SKClient as a target dependency:
 
 ```swift
 import PackageDescription
@@ -31,22 +31,23 @@ let package = Package(
 </details>
 <details>
   <summary><strong>Carthage</strong></summary>
-Add SlackKit to your `Cartfile`:
+Add SlackKit to your <code>Cartfile</code>:
 
 ```
 github "pvzig/SlackKit"
 ```
+
 and run
 
 ```
 carthage bootstrap
 ```
 
-Drag the built `SKClient.framework` and it's dependency `SKCore.framework` into your Xcode project.
+Drag the built <code>SKClient.framework</code> and it's dependency <code>SKCore.framework</code> into your Xcode project.
 </details>
 <details>
   <summary><strong>CocoaPods</strong></summary>
-Add SKClient to your `Podfile`:
+Add SKClient to your <code>Podfile</code>:
 
 ```
 use_frameworks!

diff --git a/SKRTMAPI/README.md b/SKRTMAPI/README.md
@@ -5,7 +5,7 @@ Connect to the [Slack Real Time Messaging API](https://api.slack.com/rtm) in Swi
 ## Installation
 <details>
   <summary><strong>Swift Package Manager</strong></summary>
-Add SlackKit as a dependency to your `Package.swift` and specify `SKRTMAPI` as a target dependency:
+Add SlackKit as a dependency to your <code>Package.swift</code> and specify SKRTMAPI as a target dependency:
 
 ```swift
 import PackageDescription
@@ -50,22 +50,23 @@ SKRTMAPI.dependencies = [
 </details>
 <details>
   <summary><strong>Carthage</strong></summary>
-Add SlackKit to your `Cartfile`:
+Add SlackKit to your <code>Cartfile</code>:
 
 ```
 github "pvzig/SlackKit"
 ```
+
 and run
 
 ```
 carthage bootstrap
 ```
 
-Drag the built `SKRTMAPI.framework` and it's dependencies `SKCore.framework`, `SKWebAPI.framework`, and `Starscream.framework` into your Xcode project.
+Drag the built <code>SKRTMAPI.framework</code> and it's dependencies <code>SKCore.framework</code>, <code>SKWebAPI.framework</code>, and <code>Starscream.framework</code> into your Xcode project.
 </details>
 <details>
   <summary><strong>CocoaPods</strong></summary>
-Add SKRTMAPI to your `Podfile`:
+Add SKRTMAPI to your <code>Podfile</code>:
 
 ```
 use_frameworks!

diff --git a/SKServer/README.md b/SKServer/README.md
@@ -4,7 +4,7 @@ A server-side Swift framework for creating Slack apps.
 ## Installation
 <details>
   <summary><strong>Swift Package Manager</strong></summary>
-Add SlackKit as a dependency to your `Package.swift` and specify `SKServer` as a target dependency:
+Add SlackKit as a dependency to your <code>Package.swift</code> and specify SKServer as a target dependency:
 
 ```swift
 import PackageDescription
@@ -30,22 +30,23 @@ let package = Package(
 </details>
 <details>
   <summary><strong>Carthage</strong></summary>
-Add SlackKit to your `Cartfile`:
+Add SlackKit to your <code>Cartfile</code>:
 
 ```
 github "pvzig/SlackKit"
 ```
+
 and run
 
 ```
 carthage bootstrap
 ```
 
-Drag the built `SKServer.framework` and it's dependencies `SKCore.framework`, `SKWebAPI.framework`, and `Swifter.framework` into your Xcode project.
+Drag the built <code>SKServer.framework</code> and it's dependencies <code>SKCore.framework</code>, <code>SKWebAPI.framework</code>, and <code>Swifter.framework</code> into your Xcode project.
 </details>
 <details>
   <summary><strong>CocoaPods</strong></summary>
-Add SKServer to your `Podfile`:
+Add SKServer to your <code>Podfile</code>:
 
 ```
 use_frameworks!

diff --git a/SKWebAPI/README.md b/SKWebAPI/README.md
@@ -6,7 +6,7 @@ Make requests to the [Slack Web API](https://api.slack.com/web) in Swift.
 
 <details>
   <summary><strong>Swift Package Manager</strong></summary>
-Add SlackKit as a dependency to your `Package.swift` and specify `SKWebAPI` as a target dependency:
+Add SlackKit as a dependency to your <code>Package.swift</code> and specify SKWebAPI as a target dependency:
 
 ```swift
 import PackageDescription
@@ -32,22 +32,23 @@ let package = Package(
 </details>
 <details>
   <summary><strong>Carthage</strong></summary>
-Add SlackKit to your `Cartfile`:
+Add SlackKit to your <code>Cartfile</code>:
 
 ```
 github "pvzig/SlackKit"
 ```
+
 and run
 
 ```
 carthage bootstrap
 ```
 
-Drag the built `SKWebAPI.framework` and it's dependency `SKCore.framework` into your Xcode project.
+Drag the built <code>SKWebAPI.framework</code> and it's dependency <code>SKCore.framework</code> into your Xcode project.
 </details>
 <details>
   <summary><strong>CocoaPods</strong></summary>
-Add SKWebAPI to your `Podfile`:
+Add SKWebAPI to your <code>Podfile</code>:
 
 ```
 use_frameworks!

diff --git a/SlackKit/README.md b/SlackKit/README.md
@@ -1,10 +1,9 @@
 # SlackKit: Slack Apps in Swift
 
-
-### Installation
+## Installation
 <details>
   <summary><strong>Swift Package Manager</strong></summary>
-Add `SlackKit` to your `Package.swift`
+Add SlackKit to your <code>Package.swift</code>
 
 ```swift  
 let package = Package(
@@ -20,24 +19,23 @@ You can install it with [homebrew](https://brew.sh): `brew install libressl`
 
 For additional details, see the [SKRTMAPI readme](https://github.com/pvzig/SlackKit/tree/master/SKRTMAPI#swift-package-manager).
 </details>
-
 <details>
   <summary><strong>Carthage</strong></summary>
-Add `SlackKit` to your `Cartfile`:
+Add SlackKit to your <code>Cartfile</code>:
 
 ```
 github "pvzig/SlackKit"
 ```
 </details>
-
 <details>
   <summary><strong>CocoaPods</strong></summary>
-Add `SlackKit` to your `Podfile`:
+Add SlackKit to your <code>Podfile</code>:
 
 ```
 pod 'SlackKit'
 ```
 </details>
+
 ### Usage
 To use the library in your project import it: