Skip to content

Commit 150ef53

Browse files
committed
The README and description can be more informative.
1 parent ccd02b4 commit 150ef53

File tree

2 files changed

+7
-8
lines changed

2 files changed

+7
-8
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# vile-stat [![Circle CI](https://circleci.com/gh/forthright/vile-stat.svg?style=shield&circle-token=4f88501f4048011c21e7c0fd561f82c5651cfd9b)](https://circleci.com/gh/forthright/vile-stat) [![Build status](https://ci.appveyor.com/api/projects/status/sw52hyqmiutcalb6/branch/master?svg=true)](https://ci.appveyor.com/project/brentlintner/vile-stat/branch/master) [![score-badge](https://vile.io/api/v0/projects/vile-stat/badges/score?token=USryyHar5xQs7cBjNUdZ)](https://vile.io/~brentlintner/vile-stat) [![security-badge](https://vile.io/api/v0/projects/vile-stat/badges/security?token=USryyHar5xQs7cBjNUdZ)](https://vile.io/~brentlintner/vile-stat) [![coverage-badge](https://vile.io/api/v0/projects/vile-stat/badges/coverage?token=USryyHar5xQs7cBjNUdZ)](https://vile.io/~brentlintner/vile-stat) [![dependency-badge](https://vile.io/api/v0/projects/vile-stat/badges/dependency?token=USryyHar5xQs7cBjNUdZ)](https://vile.io/~brentlintner/vile-stat)
22

3-
A [vile](https://vile.io) plugin for tracking file statistics.
3+
A [Vile](https://vile.io) plugin for tracking various code statistics
4+
including lines/loc, comments, language, and size.
45

56
## Requirements
67

7-
- [nodejs](http://nodejs.org)
8+
- [Node.js](http://nodejs.org)
89

910
## Installation
1011

@@ -22,7 +23,7 @@ stat:
2223
2324
## Versioning
2425
25-
This project ascribes to [semantic versioning](http://semver.org).
26+
This project uses [Semver](http://semver.org).
2627
2728
## Vile Types Generated
2829
@@ -53,8 +54,6 @@ Even if you are uncomfortable with code, an issue or question is welcome.
5354
5455
### Code Of Conduct
5556
56-
This project ascribes to [contributor-covenant.org](http://contributor-covenant.org).
57-
5857
By participating in this project you agree to our [Code of Conduct](CODE_OF_CONDUCT.md).
5958
6059
### Maintainers
@@ -64,10 +63,10 @@ By participating in this project you agree to our [Code of Conduct](CODE_OF_COND
6463
## Architecture
6564
6665
- `bin` houses any shell based scripts
67-
- `src` is es6+ syntax compiled with [babel](https://babeljs.io)
66+
- `src` is es6+ syntax compiled with [Babel](https://babeljs.io)
6867
- `lib` generated js library
6968

70-
## Hacking
69+
## Developing
7170

7271
cd vile-stat
7372
npm install

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "vile-stat",
33
"version": "0.1.0",
4-
"description": "A vile plugin for tracking file statistics",
4+
"description": "Track various code statistics including lines/loc, comments, language, and size.",
55
"main": "lib/index.js",
66
"files": [
77
"lib",

0 commit comments

Comments
 (0)