Permalink
Browse files

Merge branch 'master' of github.com:harthur/glossary

  • Loading branch information...
2 parents 2bc0513 + dc62087 commit 66c3157df4478001deff8128df7e2ebd76c340dc @harthur committed Oct 2, 2011
Showing with 3 additions and 5 deletions.
  1. +3 −5 README.md
View
@@ -27,7 +27,7 @@ npm install glossary
Use `blacklist` to remove unwanted terms from any extraction:
```javascript
-var glossary = require("./glossary")({
+var glossary = require("glossary")({
blacklist: ["library", "script", "api", "function"]
});
@@ -41,7 +41,7 @@ console.log(keywords); // ["color", "conversion"]
Use `minFreq` to limit the terms to only those that occur with a certain frequency:
```javascript
-var glossary = require("./glossary")({ minFreq: 2 });
+var glossary = require("glossary")({ minFreq: 2 });
var keywords = glossary.extract("Kasey's pears are the best pears in Canada");
@@ -53,7 +53,7 @@ console.log(keywords); // ["pears"]
Use `collapse` to remove terms that are sub-terms of other terms:
```javascript
-var glossary = require("./glossary")({ collapse: true });
+var glossary = require("glossary")({ collapse: true });
var keywords = glossary.extract("The Middle East crisis is getting worse");
@@ -64,8 +64,6 @@ console.log(keywords); // ["Middle East crisis"]
Use `verbose` to also get the count of each term:
-If you don't want terms that are sub-terms of other terms, use `collapse`:
-
```javascript
var glossary = require("./glossary")({ verbose: true });

0 comments on commit 66c3157

Please sign in to comment.