Data Collection Practices

README.md

@@ -15,12 +15,12 @@ CocoaLumberjack
 
 **CocoaLumberjack** is a fast & simple, yet powerful & flexible logging framework for macOS, iOS, tvOS and watchOS.
 
-### How to get started
+## How to get started
 
 First, install CocoaLumberjack via [CocoaPods](http://cocoapods.org), [Carthage](https://github.com/Carthage/Carthage), [Swift Package Manager](https://swift.org/package-manager/) or manually.
 Then use `DDOSLogger` for iOS 10 and later, or `DDTTYLogger` and `DDASLLogger` for earlier versions to begin logging messages.
 
-#### CocoaPods
+### CocoaPods
 
 ```ruby
 platform :ios, '9.0'
@@ -42,7 +42,7 @@ target 'SampleTarget' do
 end
 ```
 
-#### Carthage
+### Carthage
 
 Carthage is a lightweight dependency manager for Swift and Objective-C. It leverages CocoaTouch modules and is less invasive than CocoaPods.
 
@@ -54,7 +54,7 @@ github "CocoaLumberjack/CocoaLumberjack"
 ```
 
 
-#### Swift Package Manager
+### Swift Package Manager
 
 As of CocoaLumberjack 3.6.0, you can use the Swift Package Manager as integration method.
 If you want to use the Swift Package Manager as integration method, either use Xcode to add the package dependency or add the following dependency to your Package.swift:
@@ -65,11 +65,11 @@ If you want to use the Swift Package Manager as integration method, either use X
 
 Note that you may need to add both products, `CocoaLumberjack` and `CocoaLumberjackSwift` to your target since SPM sometimes fails to detect that `CocoaLumerjackSwift` depends on `CocoaLumberjack`.
 
-#### Install manually
+### Install manually
 
 If you want to install CocoaLumberjack manually, read the [manual installation](https://raw.githubusercontent.com/CocoaLumberjack/CocoaLumberjack/master/Documentation/GettingStarted.md#manual-installation) guide for more information.
 
-#### Swift Usage
+### Swift Usage
 
 Usually, you can simply `import CocoaLumberjackSwift`. If you installed CocoaLumberjack using CocoaPods, you need to use `import CocoaLumberjack` instead.
 
@@ -90,7 +90,7 @@ DDLogWarn("Warn")
 DDLogError("Error")
 ```
 
-#### Obj-C usage
+### Obj-C usage
 
 If you're using Lumberjack as a framework, you can `@import CocoaLumberjack;`.
 Otherwise, `#import <CocoaLumberjack/CocoaLumberjack.h>`
@@ -111,13 +111,13 @@ DDLogInfo(@"Info");
 DDLogWarn(@"Warn");
 DDLogError(@"Error");
 ```
-#### Objective-C ARC Semantic Issue
+### Objective-C ARC Semantic Issue
 
 When integrating Lumberjack into an existing Objective-C it is possible to run into `Multiple methods named 'tag' found with mismatched result, parameter type or attributes` build error.
 
 Add `#define DD_LEGACY_MESSAGE_TAG 0` before importing CocoaLumberjack or add `#define DD_LEGACY_MESSAGE_TAG 0` or add `-DDD_LEGACY_MESSAGE_TAG=0` to *Other C Flags*/*OTHER_CFLAGS* in your Xcode project.
 
-### [swift-log](https://github.com/apple/swift-log) backend
+## [swift-log](https://github.com/apple/swift-log) backend
 
 CocoaLumberjack also ships with a backend implementation for [swift-log](https://github.com/apple/swift-log).
 Simply add CocoaLumberjack as dependency to your SPM target (see above) and also add the `CocoaLumberjackSwiftLogBackend` product as dependency to your target.
@@ -127,49 +127,49 @@ You can then use `DDLogHandler` as backend for swift-log, which will forward all
 In your own log formatters, you can make use of the `swiftLogInfo` property on `DDLogMessage` to retrieve the details of a message that is logged via swift-log.
 
 
-#### More information
+### More information
 
 - read the [Getting started](https://raw.githubusercontent.com/CocoaLumberjack/CocoaLumberjack/master/Documentation/GettingStarted.md) guide, check out the [FAQ](https://raw.githubusercontent.com/CocoaLumberjack/CocoaLumberjack/master/Documentation/FAQ.md) section or the other [docs](Documentation/)
 - if you find issues or want to suggest improvements, create an issue or a pull request
 - for all kinds of questions involving CocoaLumberjack, use the [Google group](http://groups.google.com/group/cocoalumberjack) or StackOverflow (use [#lumberjack](http://stackoverflow.com/questions/tagged/lumberjack)).
 
 
-### CocoaLumberjack 3
+## CocoaLumberjack 3
 
-#### Migrating to 3.x
+### Migrating to 3.x
 
 * To be determined
 
-### Features
+## Features
 
-#### Lumberjack is Fast & Simple, yet Powerful & Flexible.
+### Lumberjack is Fast & Simple, yet Powerful & Flexible.
 
 It is similar in concept to other popular logging frameworks such as log4j, yet is designed specifically for Objective-C, and takes advantage of features such as multi-threading, grand central dispatch (if available), lockless atomic operations, and the dynamic nature of the Objective-C runtime.
 
-#### Lumberjack is Fast
+### Lumberjack is Fast
 
 In most cases it is an order of magnitude faster than NSLog.
 
-#### Lumberjack is Simple
+### Lumberjack is Simple
 
 It takes as little as a single line of code to configure lumberjack when your application launches. Then simply replace your NSLog statements with DDLog statements and that's about it. (And the DDLog macros have the exact same format and syntax as NSLog, so it's super easy.)
 
-#### Lumberjack is Powerful:
+### Lumberjack is Powerful:
 
 One log statement can be sent to multiple loggers, meaning you can log to a file and the console simultaneously. Want more? Create your own loggers (it's easy) and send your log statements over the network. Or to a database or distributed file system. The sky is the limit.
 
-#### Lumberjack is Flexible:
+### Lumberjack is Flexible:
 
 Configure your logging however you want. Change log levels per file (perfect for debugging). Change log levels per logger (verbose console, but concise log file). Change log levels per xcode configuration (verbose debug, but concise release). Have your log statements compiled out of the release build. Customize the number of log levels for your application. Add your own fine-grained logging. Dynamically change log levels during runtime. Choose how & when you want your log files to be rolled. Upload your log files to a central server. Compress archived log files to save disk space...
 
-### This framework is for you if:
+## This framework is for you if:
 
 -   You're looking for a way to track down that impossible-to-reproduce bug that keeps popping up in the field.
 -   You're frustrated with the super short console log on the iPhone.
 -   You're looking to take your application to the next level in terms of support and stability.
 -   You're looking for an enterprise level logging solution for your application (Mac or iPhone).
 
-### Documentation
+## Documentation
 
 - **[Get started using Lumberjack](https://github.com/CocoaLumberjack/CocoaLumberjack/blob/master/Documentation/GettingStarted.md)**<br/>
 - [Different log levels for Debug and Release builds](https://github.com/CocoaLumberjack/CocoaLumberjack/blob/master/Documentation/XcodeTricks.md)<br/>
@@ -182,7 +182,7 @@ Configure your logging however you want. Change log levels per file (perfect for
 - [AppCode support](https://github.com/CocoaLumberjack/CocoaLumberjack/blob/master/Documentation/AppCode-support.md)
 - **[Full Lumberjack documentation](Documentation/)**<br/>
 
-### Requirements
+## Requirements
 The current version of Lumberjack requires:
 - Xcode 12 or later
 - Swift 5.3 or later
@@ -191,7 +191,7 @@ The current version of Lumberjack requires:
 - watchOS 3 or later
 - tvOS 9 or later
 
-#### Backwards compatibility
+### Backwards compatibility
 - for Xcode 11 and Swift up to 5.2, use the 3.6.2 version
 - for Xcode 10 and Swift 4.2, use the 3.5.2 version
 - for iOS 8, use the 3.6.1 version
@@ -205,19 +205,61 @@ The current version of Lumberjack requires:
 - for Xcode 6 or earlier, use the 2.0.x version
 - for OS X < 10.7 support, use the 1.6.0 version
 
-### Communication
+## Communication
 
 - If you **need help**, use [Stack Overflow](http://stackoverflow.com/questions/tagged/lumberjack). (Tag 'lumberjack')
 - If you'd like to **ask a general question**, use [Stack Overflow](http://stackoverflow.com/questions/tagged/lumberjack).
 - 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.
 
-### Author
+## Data Collection Practices
+
+Per  [App privacy details on the App Store](https://developer.apple.com/app-store/app-privacy-details/), Apple is requesting app developers to provide info about their data collection, us SDK maintainers must provide them with the same data.
+
+### Data collection by the framework
+
+**By default, CocoaLumberjack does NOT collect any data on its own.** 
+
+[See our Data Collection Practices list.](https://cocoalumberjack.github.io/DataCollection/index.html)
+
+### Indirect data collection through the framework
+
+CocoaLumberjack is a logging framework which makes it easy to send those logs to different platforms.
+
+This is why collecting  data might happen quite easily, if the app developers include any sensitive data into the logs.
+
+**Important note: app developers are fully responsible for any sensitive data collected through our logging system!**
+
+In consequence, you must comply to the Apple's privacy details policy (mentioned above) and document the ways in which user data is being collected.
+Since the number of scenarios where data might be indirectly collected through CocoaLumberjack is quite large, it's up to you, as app developers, to properly review your app's code and identify those cases.
+What we can do to help is raise awareness about potential data collection through our framework.
+
+Private data includes but isn't limited to:
+
+- user info (name, email, address, ...)
+- location info
+- contacts
+- identifiers (user id, device id, ...)
+- app usage data
+- performance data
+- health and fitness info
+- financial info
+- sensitive info
+- user content
+- history (browsing, search, ...)
+- purchases
+- diagnostics
+- ...
+
+_Example_: `DDLogInfo("User: \(myUser)")` will add the `myUser` info to the logs, so if those are forwarded to a 3rd party or sent via email, that may qualify as data collection.
+
+## Author
+
 - [Robbie Hanson](https://github.com/robbiehanson)
 - Love the project? Wanna buy me a coffee? (or a beer :D) [![donation](http://www.paypal.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=UZRA26JPJB3DA)
 
-### Collaborators
+## Collaborators
 - [Ernesto Rivera](https://github.com/rivera-ernesto)
 - [Dmitry Vorobyov](https://github.com/dvor)
 - [Bogdan Poplauschi](https://github.com/bpoplauschi)
@@ -230,14 +272,14 @@ The current version of Lumberjack requires:
 - [Dmitry Lobanov](https://github.com/lolgear)
 - [Hakon Hanesand](https://github.com/hhanesand)
 
-### License
+## License
 - CocoaLumberjack is available under the BSD 3 license. See the [LICENSE file](https://github.com/CocoaLumberjack/CocoaLumberjack/blob/master/LICENSE).
 
-### Extensions
+## Extensions
 - [LogIO-CocoaLumberjack](https://github.com/s4nchez/LogIO-CocoaLumberjack) A log.io logger for CocoaLumberjack
 - [XCDLumberjackNSLogger](https://github.com/0xced/XCDLumberjackNSLogger) CocoaLumberjack logger which sends logs to NSLogger
 
-### Architecture
+## Architecture
 
 <p align="center" >
     <img src="https://raw.githubusercontent.com/CocoaLumberjack/CocoaLumberjack/master/Documentation/CocoaLumberjackClassDiagram.png" title="CocoaLumberjack class diagram">