CHORE: Update README & examples

Author: trinhngocthuyen

README.md

@@ -1,11 +1,51 @@
 # cocoapods-xcconfig-hooks
 
-CocoaPods plugin to hook xcconfig of CocoaPods targets.
+[![Test](https://img.shields.io/github/workflow/status/trinhngocthuyen/cocoapods-xcconfig-hooks/test)](https://img.shields.io/github/workflow/status/trinhngocthuyen/cocoapods-xcconfig-hooks/test)
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat&color=blue)](https://github.com/trinhngocthuyen/cocoapods-xcconfig-hooks/blob/main/LICENSE.txt)
+[![Gem](https://img.shields.io/gem/v/cocoapods-xcconfig-hooks.svg?style=flat&color=blue)](https://rubygems.org/gems/cocoapods-xcconfig-hooks)
+
+A CocoaPods plugin to hook xcconfig of CocoaPods targets.
 
 ## Installation
 
     $ gem install cocoapods-xcconfig-hooks
 
 ## Usage
 
-TBU
+### Load the plugin
+
+Load this plugin by adding the following line at the beginning of Podfile (example: [here](/examples/Podfile#L4)).
+
+```rb
+plugin "cocoapods-xcconfig-hooks"
+```
+
+### Configure the plugin (optional)
+
+In Podfile, call the `config_xcconfig_hooks` method to provide customization for your setup (example: [here](/examples/Podfile#L6)).
+
+```rb
+config_xcconfig_hooks(
+  hook_dir: "path/to/xcconfig/dir",
+  aggregate_targets_only: true
+)
+```
+
+The following table explains the parameters of the `config_xcconfig_hooks` method.
+
+| Parameter              | Type    | Default    | Description                                                                    |
+|------------------------|---------|------------|--------------------------------------------------------------------------------|
+| `hook_dir`               | string  | `.xcconfigs` | Path to the directory containing xcconfig files (relative to the project directory)                                |
+| `aggregate_targets_only` | boolean | `true`       | Whether to hook aggregate targets only (ex. Pods-App, Pods-AppUITests...) |
+
+After pod installation, the settings defined in those xcconfig files should be hooked to the project.
+
+![](/resources/xcconfig.png)
+
+### Order of xcconfig hooks
+
+xcconfig files (if present in the `hook_dir`) are included in the following order.
+- `__base__.xcconfig`
+- `<configuration_name>.xcconfig` (ex. `debug.xcconfig`)
+- `<TargetName>.__base__.xcconfig` (ex: `Pods-Example.__base__.xcconfig`)
+- `<TargetName>.<configuration_name>.xcconfig` (ex: `Pods-Example.debug.xcconfig`)

examples/Podfile

@@ -3,6 +3,11 @@ use_frameworks!
 
 plugin "cocoapods-xcconfig-hooks"
 
+config_xcconfig_hooks(
+  hook_dir: "xcconfigs", # https://github.com/trinhngocthuyen/cocoapods-xcconfig-hooks/tree/main/examples/xcconfigs
+  aggregate_target_only: true
+)
+
 target "Example" do
   # Pods declaration goes here
 end

examples/Podfile.lock

@@ -1,3 +1,3 @@
-PODFILE CHECKSUM: aa11db2435ec6815332271a695bf71a281ddf018
+PODFILE CHECKSUM: d778bf15658ea86382d1bcea9ac9ac700e348015
 
 COCOAPODS: 1.11.3

examples/xcconfigs/Pods-Example.__base__.xcconfig

@@ -0,0 +1,3 @@
+// Here, you can provide settings that should apply accross configurations, but to a particular target only
+
+HOOKED_SETTING_EXAMPLE = default value

examples/xcconfigs/Pods-Example.debug.xcconfig

@@ -0,0 +1,3 @@
+// Here, you can provide settings that should apply to a particular target and a particular configuration only
+
+HOOKED_SETTING_EXAMPLE = something particular to app target (debug)

examples/xcconfigs/__base__.xcconfig

@@ -0,0 +1,3 @@
+// Here, you can provide settings that should apply accross targets and configurations
+
+HOOKED_SETTING = default value

examples/xcconfigs/debug.xcconfig

@@ -0,0 +1,3 @@
+// Here, you can provide settings that should apply accross targets, but to a particular configuration only
+
+HOOKED_SETTING = value for debug