From ca143e91fa897b8ef5cd898d7d53f8977fd79efa Mon Sep 17 00:00:00 2001
From: Nic Capdevila <nic.capdevila@gmail.com>
Date: Tue, 21 Nov 2017 17:11:58 -0600
Subject: [PATCH] Update README.md

---
 README.md | 103 +++++++++++++++++++++++++++++++++++-------------------
 1 file changed, 67 insertions(+), 36 deletions(-)

diff --git a/README.md b/README.md
index 17d4fa71..23e70731 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ With [Material Design Bottom Navigation pattern](https://www.google.com/design/s
 ## Gradle
 
 ```groovy
-implementation 'com.ncapdevi:frag-nav:2.3.0'   //or or `compile` if on older gradle version
+implementation 'com.ncapdevi:frag-nav:2.4.0'   //or or `compile` if on older gradle version
 ```
 
 ## How do I implement it?
@@ -161,16 +161,16 @@ Use FragNavController.setTransitionMode();
 
 ### Helper functions
 ```java
-
-   /**
+    /**
      * Get the number of fragment stacks
      *
      * @return the number of fragment stacks
      */
     @CheckResult
-    public int getSize()
-    
-    
+    public int getSize() {
+        return mFragmentStacks.size();
+    }
+
     /**
      * Get a copy of the stack at a given index
      *
@@ -179,42 +179,73 @@ Use FragNavController.setTransitionMode();
     @SuppressWarnings("unchecked")
     @CheckResult
     @Nullable
-    public Stack<Fragment> getStack(@TabIndex int index)
-    
-        /**
-         * Get a copy of the current stack that is being displayed
-         *
-         * @return Current stack
-         */
-        @SuppressWarnings("unchecked")
-        @CheckResult
-        @Nullable
-        public Stack<Fragment> getCurrentStack()
-        
-            /**
-             * Get the index of the current stack that is being displayed
-             *
-             * @return Current stack index
-             */
-            @CheckResult
-            @TabIndex
-            public int getCurrentStackIndex()
-            
-            
+    public Stack<Fragment> getStack(@TabIndex int index) {
+        if (index == NO_TAB) {
+            return null;
+        }
+        if (index >= mFragmentStacks.size()) {
+            throw new IndexOutOfBoundsException("Can't get an index that's larger than we've setup");
+        }
+        return (Stack<Fragment>) mFragmentStacks.get(index).clone();
+    }
+
+    /**
+     * Get a copy of the current stack that is being displayed
+     *
+     * @return Current stack
+     */
+    @SuppressWarnings("unchecked")
+    @CheckResult
+    @Nullable
+    public Stack<Fragment> getCurrentStack() {
+        return getStack(mSelectedTabIndex);
+    }
+
+    /**
+     * Get the index of the current stack that is being displayed
+     *
+     * @return Current stack index
+     */
+    @CheckResult
+    @TabIndex
+    public int getCurrentStackIndex() {
+        return mSelectedTabIndex;
+    }
+
     /**
      * @return If true, you are at the bottom of the stack
      * (Consider using replaceFragment if you need to change the root fragment for some reason)
      * else you can popFragment as needed as your are not at the root
      */
     @CheckResult
-    public boolean isRootFragment()
-    
-        /**
-         * @return Current DialogFragment being displayed. Null if none
-         */
-        @Nullable
-        @CheckResult
-        public DialogFragment getCurrentDialogFrag()
+    public boolean isRootFragment() {
+        Stack<Fragment> stack = getCurrentStack();
+
+        return stack == null || stack.size() == 1;
+    }
+
+    /**
+     * Helper function to get wether the fragmentManger has gone through a stateSave, if this is true, you probably want to commit  allowing stateloss
+     *
+     * @return if fragmentManger isStateSaved
+     */
+    public boolean isStateSaved() {
+        return mFragmentManager.isStateSaved();
+    }
+
+    /**
+     *  Use this if you need to make sure that pending transactions occur immediately. This call is safe to
+     *  call as often as you want as there's a check to prevent multiple executePendingTransactions at once
+     *
+     */
+    public void executePendingTransactions() {
+        if (!mExecutingTransaction) {
+            mExecutingTransaction = true;
+            mFragmentManager.executePendingTransactions();
+            mExecutingTransaction = false;
+        }
+    }
+
     
 ```
 ## Apps Using FragNav