Skip to content

Commit

Permalink
Update README.md (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
oshai authored and avantgardnerio committed Nov 12, 2018
1 parent 4454990 commit 112aeee
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,17 @@ broken apis:
Then pick a version from the list!

## Building
```bash
git clone https://github.com/bgard6977/depends.git
cd dependes
./gradlew build
# This will create depends.jar
# Now, You'll need to run mvn install or gradle install on your project, to put build your code and put the resulting jar into your maven/gradle local cache.
# After you've done artifact install, you can run depends on it like that:
java -jar build/libs/depends-1.0-SNAPSHOT.jar com.mycompany.app:my-app:1.0-SNAPSHOT --filter=JsonParseException
# com.mycompany.app:my-app:1.0-SNAPSHOT is the artifact you want to check.

1. `git clone https://github.com/bgard6977/depends.git`
1. `./gradlew build`

```
## How it works

1. It uses [ShrinkWrap Resolver](http://arquillian.org/modules/resolver-shrinkwrap/) to build a dependency graph of your project.
Expand All @@ -71,4 +78,4 @@ Then pick a version from the list!
1. Produce a report to name-and-shame [semver](https://semver.org/) violations.
1. Convert this project into a [Gradle ResolutionStrategy](https://docs.gradle.org/current/dsl/org.gradle.api.artifacts.ResolutionStrategy.html) so it Just Works.



0 comments on commit 112aeee

Please sign in to comment.