Skip to content

Commit ce28d7f

Browse files
authored
Update README.md
1 parent 3ba8562 commit ce28d7f

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

+16-5
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,27 @@ Finds and outputs all API routes found in a .NET assembly in textual or JSON for
2323
- `dotnet tool install -g Makspll.Pathfinder`
2424

2525
# Usage
26-
```
27-
pathfinder help
26+
Run `pathfinder help` to see all available arguments
27+
28+
## Analysis
29+
You can find all available routes in your assemblies using the `analyze` command:
2830

29-
echo "Analyze and report on a dll"
31+
```
3032
pathfinder analyze **/bin/**/yourdllname.dll
31-
pathfinder report **/bin/**/yourdllname.dll
3233
```
3334

3435
![image](https://i.imgur.com/2Oz4HJA.png)
3536

37+
## Report
38+
You can also generate a report based on the analysis using the `report` command:
39+
40+
```
41+
pathfinder report **/bin/**/yourdllname.dll
42+
```
43+
44+
![image](https://imgur.com/CLpUY3W.png)
45+
46+
3647
# Configuration
3748

3849
## Config file
@@ -113,4 +124,4 @@ In .NET framework projects, you will need to specify whether each of your routes
113124
}
114125
]
115126
}
116-
```
127+
```

0 commit comments

Comments
 (0)