Skip to content

Commit

Permalink
minor corrections to readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
nstraub committed Mar 17, 2016
1 parent 245bbc9 commit 6b47541
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

a lightweight, small, high level dependency injector with support for object lifetime management

> This software is still not fully baked, at version 0.2, and missing a wealth of functionalities for what constitutes a fully fledged dependency injector
> This software is still not fully baked, at version 0.3, and missing a wealth of functionalities for what constitutes a fully fledged dependency injector
With that said, I expect to have a fully functional, fully tested, fully decoupled and fully documented version in the next couple of Months. I will greatly appreciate help from early adopters and will gladly embrace feature requests and bug reports uploaded to the issue tracker.

Expand All @@ -28,7 +28,7 @@ With that said, I expect to have a fully functional, fully tested, fully decoupl
- [injector.getType](#utility-gettype)
- [injector.extend](#utility-extend)
- [injector.noConflict](#utility-noConflict)
- [injector.hide](#utility-hide)
- [injector.removeDefaultListener](#utility-removeDefaultListener)
- [injector.clearState](#utility-clearState)
4. [Test Helpers](#testing)
- [injector.registerFake](#testing-fakes)
Expand Down Expand Up @@ -377,15 +377,15 @@ Restores the old value of window.injector

injector.noConflict()

### <a name="utility-hide"></a>injector.hide
### <a name="utility-removeDefaultListener"></a>injector.removeDefaultListener

De-registers `hashchange` event for clearing state lifetime `types`.

> **Note:** by default, InjectJS assumes your application is changing state (i.e. moving to another area of the application) every time the hash portion of the URL is changed. While this may be the default behaviour for most web sites, and is encouraged by most routers (like `Backbone`'s `routes`, `simrou`, `AngularJS ng-route`'s default behaviour), more and more sites are adopting HTML5 pushstate, and there are quite a few SPA's which don't use the hash at all. for those sites, you should call this method and then register a handler for your particular state change that calls `injector.clearState`
**signature**

injector.hide()
injector.removeDefaultListener()

### <a name="utility-clearState"></a>injector.clearState

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "inject-js",
"version": "v0.3.0",
"version": "v0.3.1",
"description": "lightweight, small, high level dependency injector with object lifetime management",
"main": "dist/inject.js",
"files": ["dist"],
Expand Down

0 comments on commit 6b47541

Please sign in to comment.