readme.md in code_stats2-0.1.3 vs readme.md in code_stats2-0.1.4
- old
+ new
@@ -1,26 +1,28 @@
-# Code Stats
+# CodeStats
+Source code statistics and metrics.
+
[![rails-thumb]][rails-img] [![some-os-projects-thumb]][some-os-projects-img] [![mongoid-vs-mongomapper-thumb]][mongoid-vs-mongomapper-img]
-Screenshots are showing us: Complexity of [Rails libraries][rails-img], comparison of [some Open Source projects][some-os-projects-img] and [MongoMapper vs Mongoid][mongoid-vs-mongomapper-img] (You can see actual .html report files in [docs][docs]).
+Screenshots showing us: Complexity of [Rails libraries][rails-img], comparison of [some Open Source projects][some-os-projects-img] and [MongoMapper vs Mongoid][mongoid-vs-mongomapper-img] (You can see actual .html report files in [docs][docs]).
# Installation & Usage
-This tool is language-agnostic, but it itself is made with Ruby, so You need Ruby installed to use it. Next, just install it as a gem:
+This tool is language-agnostic, but it itself is made with Ruby, so You need Ruby installed to use it, to install it type:
``` bash
gem install code_stats2
```
-Now run it on some of Your projects, You can also specify some options (type code_stats without arguments to see full help):
+Now run it on some of Your projects, You can also specify some options (type '$ code_stats' without arguments to see full help):
``` bash
code_stats /projects/wordpress
code_stats /projects/* except: JavaScript
```
-Also You can easily customize it, sources of Code Stats is small and simple as an egg - You can easilly examine all of them in about 20-30 minutes and be able to easilly hack it.
+Also You can easily customize it, sources are small and simple as an egg.
Copyright (c) Alexey Petrushin http://petrush.in, released under the MIT license.
[docs]: https://github.com/alexeypetrushin/code_stats/tree/master/docs
\ No newline at end of file