Skip to content

Commit

Permalink
README.md docs updated with dSYM translation;
Browse files Browse the repository at this point in the history
  • Loading branch information
Tomasz Grynfelder committed Mar 6, 2015
1 parent a143cc7 commit a72ef78
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,23 @@ iOS Class Guard lets you reverse the process of obfuscation. It might come in ha
-c crashdump -m symbols_1.0.0.json
```

#### Reversing obfuscation in dSYMs
iOS Class Guard lets you reverse the process of obfuscation for automatic crash reporting tools such as Crashlytics, Fabric, BugSense/Splunk Mint, Crittercism or HockeyApp. With ```--dsym``` parameter, iOS Class Guard will exchange obfuscated symbols with original ones within provided dSYM file. We highly recommend you adding in the very beginnig of your Build Phases/Run script one line shown in the example below to automate dSYM translation process. Feature has been tested with the tools mentioned above.

##### Build Phases/Run script example
```
if [ -f "$PROJECT_DIR/symbols.json" ]; then
/usr/local/bin/ios-class-guard -m $PROJECT_DIR/symbols.json --dsym $DWARF_DSYM_FOLDER_PATH/$DWARF_DSYM_FILE_NAME --dsym-out $DWARF_DSYM_FOLDER_PATH/$DWARF_DSYM_FILE_NAME
fi
# Another invocations eg.: ./Crashlytics.framework/run <Crashlytics secret #1> <Crashlytics secret #2>
```

##### Manual usage example
```
ios-class-guard -m symbols.json --dsym MyProject_obfuscated.app.dSYM --dsym-out MyProject_unobfuscated.app.dSYM
```

Limitations
-----------

Expand Down

0 comments on commit a72ef78

Please sign in to comment.