README.md in swoop_report-0.2.1 vs README.md in swoop_report-0.2.2
- old
+ new
@@ -1,6 +1,6 @@
-# Swoop : Swift to Objective-C conversion reporter
+# Swoop : Swift and Objective-C comparison reporter
[![Gem](https://img.shields.io/gem/v/swoop_report.svg)][rubygems]
[![Build Status](http://img.shields.io/travis/ikhsan/swoop/master.svg)][travis]
[![Coverage Status](http://img.shields.io/coveralls/ikhsan/swoop/master.svg)][coveralls]
@@ -56,17 +56,17 @@
```
Say, you want to compare all of the classes then run :
```bash
-$ swoop --path "~/YourAwesomeProject/AwesomeProject.xcodeproj" --dir 'Classes'
+$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes'
```
Or, if you want to compare only files inside `Controller`, run :
```bash
-$ swoop --path "~/YourAwesomeProject/AwesomeProject.xcodeproj" --dir 'Classes/Controller'
+$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes/Controller'
```
### Options
#### Path (`--path`)
@@ -80,37 +80,43 @@
#### Tags (`--tags`)
Specify a number of how many tags you want to include for comparison. For example, if you want to include the last 10 tags you would run:
```bash
-$ swoop --path "~/YourAwesomeProject/AwesomeProject.xcodeproj" --dir 'Classes' --tags 10
+$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes' --tags 10
```
#### Filter Tag (`--filter_tag`)
-Specify a regular expression that will be applied to tag names. This only applies if tags is used. For example, if
+Specify a regular expression that will be applied to tag names. This only applies if tags is used. For example, if you only want to include tags that look like `v1.0.0`, then you would run:
+```bash
+$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes' --tags 10 --filter_tag 'v\d+.\d+.\d+'
+```
+
#### Weeks (`--weeks`)
Specify a number of how many weeks you want to include for comparison. For example, if you want to include the last 30 weeks, run :
```bash
-$ swoop --path "~/YourAwesomeProject/AwesomeProject.xcodeproj" --dir 'Classes' --weeks 30
+$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes' --weeks 30
```
+Note: If both `--tags` and `--weeks` are specified, weeks will take priority.
+
#### Renderer (`--render`)
Specify how do you render the reports. Available renderers are `table`, `csv` and `chart`
##### Table
This renders a table in your console. Table is used if `--render` is not specified.
```bash
-$ swoop --path "~/YourAwesomeProject/AwesomeProject.xcodeproj" --dir 'Classes'
+$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes'
# or
-$ swoop --path "~/YourAwesomeProject/AwesomeProject.xcodeproj" --dir 'Classes' --render table
+$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes' --render table
```
will output this table in your console
![table](/screenshots/table.png?raw=true)
@@ -119,18 +125,18 @@
##### CSV
This will export your report as a csv file in root.
```bash
-$ swoop --path "~/YourAwesomeProject/AwesomeProject.xcodeproj" --dir 'Classes' --render csv
+$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes' --render csv
```
##### Chart
This will export your report as a chart in a webpage. It creates an `html` folder in root with the page `index.html` inside of it.
```bash
-$ swoop --path "~/YourAwesomeProject/AwesomeProject.xcodeproj" --dir 'Classes' --render chart
+$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes' --render chart
```
will output a chart in `./html/index.html`
![chart](/screenshots/chart.png?raw=true)