From c92bdb4ee85f3f16ec403fb0bc9a388820bb1b66 Mon Sep 17 00:00:00 2001 From: Tj Holowaychuk Date: Wed, 3 Aug 2011 06:21:13 -0700 Subject: [PATCH] rename docs --- Readme.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Readme.md b/Readme.md index 2757470..171559a 100644 --- a/Readme.md +++ b/Readme.md @@ -1,5 +1,5 @@ -# jss +# stats JavaScript statistics library built on uglify-js, reporting all sorts of interesting (and non-interesting) stats. Comes complete with an extremely simple js API, as well as a CLI. @@ -9,10 +9,10 @@ ## Example - The following is an example of `jss(1)` running against the nodejs core libraries, completing in less than 300ms. + The following is an example of `stats(1)` running against the nodejs core libraries, completing in less than 300ms. ``` - λ projects: jss --totals node/lib + λ projects: stats --totals node/lib totals: loc: 14855 @@ -50,13 +50,13 @@ totals: ## API -### .stats(js) +### .parse(js) Returns statistics for the given string of `js`: ```js -var jss = require('jss'); -console.log(jss.stats(str)) +var stats = require('stats'); +console.log(stats.parse(str)) ``` Outputs something similar to: