Skip to content

Commit

Permalink
fix(doc): fix typo + badges
Browse files Browse the repository at this point in the history
  • Loading branch information
vogloblinsky committed Apr 9, 2018
1 parent 9e5845f commit 7e3b184
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 4 deletions.
3 changes: 3 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
screenshots/
tsconfig.json
tslint.json
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
<p align="center">
<a href="https://www.npmjs.com/package/@compodoc/ts-stats"><img src="https://badge.fury.io/js/%40compodoc%2Fts-stats.svg" alt="npm badge"></a>
<a href="https://david-dm.org/compodoc/ts-stats"><img src="https://david-dm.org/compodoc/ts-stats.svg" alt="npm dependencies"></a>
<a href="https://david-dm.org/compodoc/ts-stats?type=dev"><img src="https://david-dm.org/compodoc/ts-stats/dev-status.svg" alt="npm devDependencies"></a>
<a href="http://opensource.org/licenses/MIT"><img src="http://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT badge"></a>
</p>

# ts-stats
Gives statistics about your TypeScript files

Expand All @@ -21,7 +28,7 @@ yarn global add @compodoc/ts-stats

## Usage

Use ts-stats near a `tsconfig.json` file.
Use __`ts-stats`__ near a `tsconfig.json` file.

```
$ ts-stats
Expand Down
9 changes: 6 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@compodoc/ts-stats",
"version": "1.0.0",
"description": "Gets some stats of any TypeScript application",
"description": "Gets some statistics of any TypeScript application",
"main": "dist/index.js",
"bin": {
"ts-stats": "dist/index.js"
Expand All @@ -11,9 +11,12 @@
"url": "git@github.com:compodoc/ts-stats.git"
},
"scripts": {
"postinstall": "tsc"
"prepublishOnly": "tsc"
},
"keywords": [],
"keywords": [
"typescript",
"statistics"
],
"author": {
"email": "contact@wassimchegham.com",
"name": "Wassim Chegham",
Expand Down

0 comments on commit 7e3b184

Please sign in to comment.