Skip to content

Commit 9147554

Browse files
committed
update readme
1 parent 90e22bd commit 9147554

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed

README.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# cocoapods-developing-folder
22

3-
A cocoapods plugin provide a branch of tools for who heavily use development pods in project:
3+
A cocoapods plugin provide a branch of tools for who heavily use development pods in project. You can do these:
44

5-
- Availability to preserves the folder structure in `development pods`
6-
- Provides a new keyword `folder` to import all local pods in a specific folder and its subfolders
7-
- Function to inhibit warnings for specific pods with a block.
5+
- new keyword `local_pod` to import a local pod without specifying path
6+
- new keyword `folder` to import all local pods in a specific folder and its subfolders
7+
- preserves the folder structure in `development pods`
8+
- inhibit warnings for specific pods with a block.
89

910

1011
## Installation
@@ -13,18 +14,18 @@ A cocoapods plugin provide a branch of tools for who heavily use development po
1314

1415
## Usage
1516

16-
#### 🔸 Preserves the folder structure
17-
18-
Add the following to your podfile
17+
Firstly, you should add this in head of Podifle:
1918

2019
```ruby
2120
plugin 'cocoapods-developing-folder'
22-
use_folders
2321
```
2422

25-
If you don't want to create groups for top level folders (Local pods are usually grouped in the same folder):
23+
#### 🔸 Import a local pods without specifying path
24+
25+
Use `local_pod` just like `pod` keyword. No need to adding path. E.g.
26+
2627
```ruby
27-
use_folders :skip_top_level_group => ["modules"]
28+
local_pod "Evangelion" # no need for `:path => "modules/Evangelion"`
2829
```
2930

3031
#### 🔸 Import all local pods in specific folder
@@ -39,6 +40,7 @@ target "ABC" do
3940
pod "SnapKit"
4041
folder "frameworks/core" # 'frameworks/core' is just a relative path to podfile
4142
folder "modules" # it will import all pod in 'modules' folder and its subfolders
43+
folder "libs", :inhibit_warnings => true # the option will apply to all pods in the libs folder
4244
end
4345
```
4446

@@ -51,6 +53,19 @@ pod "Shinji", :path => "modules/some/path/to/Shinji"
5153
#...
5254
```
5355

56+
#### 🔸 Preserves the folder structure
57+
58+
Add the following to your podfile
59+
60+
```ruby
61+
use_folders
62+
```
63+
64+
If you don't want to create groups for top level folders (Local pods are usually grouped in the same folder):
65+
```ruby
66+
use_folders :skip_top_level_group => ["modules"]
67+
```
68+
5469
#### 🔸 Inhibit warnings for specific pods
5570

5671
Add the following to your podfile

0 commit comments

Comments
 (0)