diff --git a/README.md b/README.md index b162feb..8f81276 100644 --- a/README.md +++ b/README.md @@ -1 +1,31 @@ # swift-dependency-updater + +The Swift Dependency Updater is a tool to automatically update dependencies of your swift package manager projects. Unlike `swift package update` it also checks if there are updates which require adjustments for the versions specified in the `Package.swift` file + +## Installation + +### [Mint](https://github.com/yonaskolb/mint) +``` +mint install Nef10/swift-dependency-updater +``` + +### Swift Package Manager +``` +git clone https://github.com/Nef10/swift-dependency-updater.git +$ cd swift-dependency-updater +$ swift run swift-dependency-updater +``` + +## Usage + +### List all dependencies and possible updates: + +`swift-dependency-updater list [] [--exclude-indirect] [--updates-only]` + +### Help + +Run `swift-dependency-updater --help` for a full list of supported commands, and `swift-dependency-updater help ` for detailed help on a specific command. + +## Inspiration + +The tool was inspired by [vintage](https://github.com/vinhnx/vintage), [spm-dependencies-checker](https://github.com/sbertix/spm-dependencies-checker), and [swift-package-dependencies-check](https://github.com/MarcoEidinger/swift-package-dependencies-check).