README.md in snuffle-0.12.1 vs README.md in snuffle-0.12.2
- old
+ new
@@ -10,15 +10,10 @@
tell you that you might want to extract those methods to a latent Address class.
Please note that Snuffle is still pre-release and will not be ready for serious
use until it hits version 1.0.0.
-## TODO
-
-* Ignore data clumps called in "loose" class methods (e.g. attr_accessor)
-* Output files in folder hierarchy that mirrors source files
-
## Installation
Add this line to your application's Gemfile:
gem 'snuffle'
@@ -35,9 +30,15 @@
$ snuffle check lib/example.rb
Checking lib/example.rb...
Results written to doc/snuffle/index.htm
+
+## Sample Output
+
+[!Overview](images/overview.png)
+
+[!Detail](images/detail.png)
## Contributing
Please note that this project is released with a [Contributor Code of Conduct](https://gitlab.com/coraline/snuffle/blob/master/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.