Skip to content

Commit edcc39a

Browse files
author
yixiang
committed
readme
1 parent 730de5f commit edcc39a

2 files changed

Lines changed: 11 additions & 7 deletions

File tree

Doc/ChineseReadme.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,20 +60,22 @@
6060
包含两个subspec,一个是包含“日志显示”的“WithLogger” subspec
6161

6262
```
63-
pod 'DoraemonKit/WithLogger'
63+
pod 'DoraemonKit/WithLogger', :configurations => ['Debug']
6464
```
6565

6666
一个是不包含“日志显示”的“Core” subspec
6767

6868
```
69-
pod 'DoraemonKit/Core'
69+
pod 'DoraemonKit/Core', :configurations => ['Debug']
7070
```
7171

7272
默认引入“Core” subspec。
7373

74-
tip:为什么要分区subspec呢?
74+
tip1:为什么要分区subspec呢?
7575
因为日志显示模块是基于CocoaLumberjack这个三方库,如果你的项目日志不是基于CocoaLumberjack,那你就没有必要引入DoraemonKit中日志显示模块了。
7676

77+
tip2:只在Debug环境中进行集成,不要带到线上。有一些hook操作会污染线上代码。
78+
7779
### 3.2: 使用DoraemonKit内置工具集的接入方式
7880
在App启动的时候添加一下代码
7981

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<br/>
1111
<br/>
1212

13-
A collection of testing tools for iOS App development.
13+
A full-featured iOS development assistant. You deserve it.
1414

1515
[Chinese Readme](https://github.com/didi/DoraemonKit/blob/master/Doc/ChineseReadme.md)
1616

@@ -55,21 +55,23 @@ DoraemonKit contains two subspecs.
5555
One is the "WithLogger" subspec that contains the log display function based on ‘CocoaLumberjack’.
5656

5757
```
58-
pod 'DoraemonKit/WithLogger'
58+
pod 'DoraemonKit/WithLogger', :configurations => ['Debug']
5959
```
6060

6161
The other one is the "Core" subspec that does not contain the log display function.
6262

6363
```
64-
pod 'DoraemonKit/Core'
64+
pod 'DoraemonKit/Core', :configurations => ['Debug']
6565
```
6666

6767
The "Core" subspec is introduced by default.
6868

69-
Tip: Why do you want to partition the subspec?
69+
Tip 1: Why do you want to partition the subspec?
7070

7171
Because the log display module is based on the third-party library "CocoaLumberjack", if you don't need it, use "Core" subspec.
7272

73+
Tip 2: Use DoraemonKit in debug model.
74+
7375
### 2: Access method using DoraemonKit's built-in toolset
7476
Add code when the app starts.
7577

0 commit comments

Comments
 (0)