Skip to content

Commit

Permalink
updated readme, because usage of lib changed
Browse files Browse the repository at this point in the history
  • Loading branch information
spjoe committed May 19, 2013
1 parent 0bcd5d6 commit 8dee300
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions README.md
Expand Up @@ -5,22 +5,19 @@
[![Dependency Status](https://gemnasium.com/spjoe/specializedSet.png)](https://gemnasium.com/spjoe/)
## Introduction

Uses a binary tree for so you have a faster impl of a set when you don not ahve a has function for your objects. When you have hashes use Hashset!
Uses a binary tree for so you have a faster impl of a set when you don not have a hash function for your objects. When you have hashes use Hashset!

You have to define a complete lesser and equality fn. For example use toString();
You have to define a complete lesser and equality fn.

## Installation

$ npm install

## Usage
```js
var SetFrameWork = require('../').SetFrameWork;
var equalityFunction = function(a,b){return a == b};
var lesserFunction = function(a,b){return a < b};

var specializedSetFrameWork = new SetFrameWork(equalityFunction, lesserFunction);
var Set = specializedSetFrameWork.Set;
var Set = require('../')(equalityFunction, lesserFunction);

var set1 = new Set(['a', 'd','c','c']);
var set2 = new Set(['b','d','e']);
Expand Down

1 comment on commit 8dee300

@Swatinem
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sind noch einige typos da, außerdem solltest du normalen text nicht einrücken, damit markdown daraus keinen

 block macht.

Please sign in to comment.