Skip to content

Commit

Permalink
update README.md file
Browse files Browse the repository at this point in the history
increase the version to 0.0.3
  • Loading branch information
t0w5a committed May 21, 2017
1 parent 351b82a commit 97bc4fb
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 7 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ PubSubDistinct
6. [Version](#version)

### <a name="description"></a>1. Description
`pubsub-distinct` or `PubSubDistinct` is an extension of the `rx-pubsub` service.
`pubsub-distinct` or `PubSubDistinct` is an extension of the [rx-pubsub](https://www.npmjs.com/package/rx-pubsub) service.
Additionally to the functionality of the `rx-pubsub` it has one more public method `publishDistinct()`
which publishes only distinct data. It means, the same data will not be published on the same event twice in a row.

#### Example:
```javascript
var pubsub = new PubSubDistinct(); // create new RxPubSub Object
var pubsub = new PubSubDistinct(); // create new PubSubDistinct Object
var eventName = 'testEvent';

console.log('register the subscriber to the event');
Expand Down Expand Up @@ -53,7 +53,8 @@ subscriber receives data: Object {testProp: "test Value 3"}

This module is separated from the `rx-pubsub` because of its dependencies and the final size of the module.
It is using `object-hash` module to generate the hash of the published data. As the result its size is 7 times bigger than `rx-pubsub`.
So, if you don't need this feature, to publish only distinct data, please take a look at the module `rx-pubsub`.
So, if you don't need this feature, to publish only distinct data, please take a look at the module
[rx-pubsub](https://www.npmjs.com/package/rx-pubsub).


### <a name="installation"></a>2. Installation
Expand Down Expand Up @@ -104,4 +105,4 @@ The description of other methods can be found in the
[https://github.com/t0w5a/pubsub-distinct](https://github.com/t0w5a/pubsub-distinct)

### <a name="version"></a>6. Version
0.0.2
0.0.3
2 changes: 1 addition & 1 deletion dist/pubsub-distinct.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/pubsub-distinct.min.js

Large diffs are not rendered by default.

Binary file modified dist/pubsub-distinct.min.js.gz
Binary file not shown.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "pubsub-distinct",
"version": "0.0.2",
"version": "0.0.3",
"description": "PubSub service based on rx-pubsub with an additional publishDistinct() method",
"main": "dist/pubsub-dictinct.min.js",
"types": "index.d.ts",
Expand Down

0 comments on commit 97bc4fb

Please sign in to comment.