Skip to content

Commit

Permalink
Merge pull request #39 from mortonfox/patch-1
Browse files Browse the repository at this point in the history
Fix some links to internal files
  • Loading branch information
dfed authored Aug 29, 2016
2 parents d97e0ca + f89606b commit 0773656
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,23 +44,23 @@ After doing the above, your users can report a bug by making a two-finger long-p

[![Bug Report Flow](BugReportFlow.gif)](BugReportFlow.gif)

Want to look at logs on device? Push an instance of [ARKLogTableViewController](Log%20Viewing/ARKLogTableViewController.h) onto the screen to view your logs.
Want to look at logs on device? Push an instance of [ARKLogTableViewController](Aardvark/ARKLogTableViewController.h) onto the screen to view your logs.

## Performance
Logs are distributed to loggers on an internal background queue that will never slow down your app. Logs observed by the log store are incrementally appended to disk and not stored in memory.

## Customize Aardvark
Want to customize how bug reports are filed? Pass your own object conforming to the [ARKBugReporter](Bug%20Reporting/ARKBugReporter.h) protocol and the desired subclass of `UIGestureRecognizer` to `[Aardvark addBugReporter:triggeringGestureRecognizerClass:]`. You can further customize how bug reports will be triggered by modifying the returned gesture recognizer.
Want to customize how bug reports are filed? Pass your own object conforming to the [ARKBugReporter](Aardvark/ARKBugReporter.h) protocol and the desired subclass of `UIGestureRecognizer` to `[Aardvark addBugReporter:triggeringGestureRecognizerClass:]`. You can further customize how bug reports will be triggered by modifying the returned gesture recognizer.

Want to change how logs are formatted? Set your own `logFormatter` on the [ARKEmailBugReporter](Bug%20Reporting/ARKEmailBugReporter.h) returned from `[Aardvark addDefaultBugReportingGestureWithEmailBugReporterWithRecipient:]`.
Want to change how logs are formatted? Set your own `logFormatter` on the [ARKEmailBugReporter](Aardvark/ARKEmailBugReporter.h) returned from `[Aardvark addDefaultBugReportingGestureWithEmailBugReporterWithRecipient:]`.

Want to log to the console? `[ARKLogDistributor defaultDistributor].defaultLogStore.printsLogsToConsole = YES;`.

Want different log files for different features? Create an [ARKLogStore](Logging/ARKLogStore.h) for each feature you want to have its own log file and add them to the default log distributor with `[[[ARKLogDistributor](Logging/ARKLogDistributor.h) defaultDistributor] addLogObserver:featureLogStore]`. Set the `logFilterBlock` on your [ARKLogStore](Logging/ARKLogStore.h) to make sure only the logs you want are observed by the [ARKLogStore](Logging/ARKLogStore.h). Use `ARKLogWithType`’s `userInfo` dictionary to specify to which feature a log pertains. See [SampleViewController](AardvarkSample/AardvarkSample/SampleViewController.m)’s `tapGestureLogStore` for an example.
Want different log files for different features? Create an [ARKLogStore](CoreAardvark/ARKLogStore.h) for each feature you want to have its own log file and add them to the default log distributor with `[[[ARKLogDistributor](Logging/ARKLogDistributor.h) defaultDistributor] addLogObserver:featureLogStore]`. Set the `logFilterBlock` on your [ARKLogStore](CoreAardvark/ARKLogStore.h) to make sure only the logs you want are observed by the [ARKLogStore](CoreAardvark/ARKLogStore.h). Use `ARKLogWithType`’s `userInfo` dictionary to specify to which feature a log pertains. See [SampleViewController](AardvarkSample/AardvarkSample/SampleViewController.m)’s `tapGestureLogStore` for an example.

Want to send your logs to third party services? One log can be easily distributed to multiple services by adding objects conforming to [ARKLogObserver](Logging/ARKLogObserver.h) to the default [ARKLogDistributor](Logging/ARKLogDistributor.h) via `addLogObserver:`. [SampleCrashlyticsLogObserver](AardvarkSample/AardvarkSample/SampleCrashlyticsLogObserver.h) is an example of an [ARKLogObserver](Logging/ARKLogObserver.h) that sends event logs to Crashlytics.
Want to send your logs to third party services? One log can be easily distributed to multiple services by adding objects conforming to [ARKLogObserver](CoreAardvark/ARKLogObserver.h) to the default [ARKLogDistributor](CoreAardvark/ARKLogDistributor.h) via `addLogObserver:`. [SampleCrashlyticsLogObserver](AardvarkSample/AardvarkSample/SampleCrashlyticsLogObserver.h) is an example of an [ARKLogObserver](CoreAardvark/ARKLogObserver.h) that sends event logs to Crashlytics.

Want to log with Aardvark but don’t want to use Aardvark’s bug reporting tool? Skip step #2 in Getting Started and manually add [ARKLogObserver](Logging/ARKLogObserver.h) to the default [ARKLogDistributor](Logging/ARKLogDistributor.h).
Want to log with Aardvark but don’t want to use Aardvark’s bug reporting tool? Skip step #2 in Getting Started and manually add [ARKLogObserver](CoreAardvark/ARKLogObserver.h) to the default [ARKLogDistributor](CoreAardvark/ARKLogDistributor.h).

## Requirements

Expand Down

0 comments on commit 0773656

Please sign in to comment.