Semantically, it's not entirely clear when to use done() vs remove().
For instance, in the case of an ajax error, I wanted to remove the progress indicator immediately so that it doesn't appear to reach completion (the right side of the screen). It seemed to make sense to just call remove() by itself, but I was still seeing the progress indicator. I had to call done() followed by remove() to get the behavior I wanted, which was for the progress indicator to immediately disappear.
Now in the case of a successful ajax completion, I just call done() which causes the progress indicator to reach completion and then disappear.
So I think the readme needs some explanation on using these two methods together.
Semantically, it's not entirely clear when to use done() vs remove().
For instance, in the case of an ajax error, I wanted to remove the progress indicator immediately so that it doesn't appear to reach completion (the right side of the screen). It seemed to make sense to just call remove() by itself, but I was still seeing the progress indicator. I had to call done() followed by remove() to get the behavior I wanted, which was for the progress indicator to immediately disappear.
Now in the case of a successful ajax completion, I just call done() which causes the progress indicator to reach completion and then disappear.
So I think the readme needs some explanation on using these two methods together.