Skip to content

Commit 56d6a35

Browse files
authored
Update README.md
1 parent 20104e2 commit 56d6a35

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
This package contains an updated implementation of the contract fragment pattern put forward by @JakeWharton that uses the parent fragment or the activity to check for a contract implementation. See the original idea [on jakes github](https://gist.github.com/JakeWharton/2621173)
2+
3+
This package also contains a base `Fragment` and `DialogFragment` implementation with bug fixes for child fragment animations and immersive dialog fragments. Learn more about these bugs [here](https://stackoverflow.com/questions/32758559/maintain-immersive-mode-when-dialogfragment-is-shown) and [here]
4+
5+
If new fragment related ui issues pop up, I'll be sure to address them in these base classes.
6+
17
# How to install
28
add the followig to gradle to install
39
```
@@ -11,13 +17,13 @@ allprojects{
1117
```
1218
dependencies {
1319
...
14-
compile 'com.github.marksalpeter:contract-fragment:1.0
20+
compile 'com.github.marksalpeter:contract-fragment:0.1
1521
}
1622
```
1723

18-
# Example
24+
# Examples
1925
```java
20-
import com.marksalpeter.contractfragment.ContractFragment;
26+
import com.marksalpeter.fragment.ContractFragment;
2127

2228
public class MyFragment extends ContractFragment<Name.Contract> {
2329

@@ -43,4 +49,4 @@ public class MyFragment extends ContractFragment<Name.Contract> {
4349
getContract().method();
4450
}
4551
}
46-
```
52+
```

0 commit comments

Comments
 (0)