Skip to content

Fix broken headings in Markdown files #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bryant1410 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix broken headings in Markdown files #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#Timberjack
# Timberjack

Automatic Swift network activity logger for iOS or OSX.

Expand All @@ -14,11 +14,11 @@ Timberjack is a simple, unintrusive network activity logger. Log every request y

<img src="https://raw.githubusercontent.com/andysmart/Timberjack/master/Assets/screenshot.jpg" width="521px" height="422px" />

##Installation
## Installation

Timberjack is installed as an embedded framework, and as such requires at least iOS8. If you require iOS7 compatibility, simply drag the `Timberjack.swift` file into your own project.

###CocoaPods
### CocoaPods

Add the following to your Podfile

Expand All @@ -32,15 +32,15 @@ pod 'Timberjack'

Then install with `pod install`

###Carthage
### Carthage

Add the following to your Cartfile

````ruby
github "andysmart/Timberjack" >= 0.0.3
````

##Usage
## Usage

Nice and easy, just register when your app loads, and Timberjack will monitor and log any requests you make via `URLSession` or `URLConnection`.

Expand All @@ -60,7 +60,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
}
````

###Using with Alamofire
### Using with Alamofire

Due to the way Alamofire uses NSURLSession, you'll need to do a little more than the standard installation to monitor all requests. The simplest way to do this is to create a subclass of `Manager` to handle your requests, then just use this in place of `Alamofire.request()`.

Expand All @@ -77,24 +77,24 @@ class HTTPManager: Alamofire.SessionManager {
}
````

###Configuration
### Configuration

Timberjack has two modes: Verbose and Light. The default style is `verbose`. To change this, just set it appropriately.

````swift
Timberjack.logStyle = .verbose //Either .Verbose, or .Light
````

##License
## License

MIT, see LICENSE for details.

##Bugs or Issues
## Bugs or Issues

Open an issue here, or ping me a message on Twitter. Even better, fork this repo and open a pull-request!

*Unfortunately, due to a limitation in `URLProtocol`, Timberjack is unable to log the HTTP body of a request, see [This radar](http://openradar.appspot.com/15993891) for more details*

##Credits
## Credits

Built by [@andyjsmart](https://twitter.com/andyjsmart)