Added README and USAGE

This commit is contained in:
jpk 2023-08-15 12:01:13 +02:00
parent 16f974f1bb
commit fae43accfc
2 changed files with 48 additions and 0 deletions

View File

@ -0,0 +1,5 @@
# Dotconfig - A git dot config repository manager
## Usage
See [USAGE.md](USAGE.md).

43
USAGE.md Normal file
View File

@ -0,0 +1,43 @@
# Dotconfig v0.1.1 - Command Usage Overview
## add
```
Usage: dotconfig add [OPTIONS] PATH
Options:
-n, --name TEXT Repository name
--help Show this message and exit.
```
## commit
```
Usage: dotconfig commit [OPTIONS]
Options:
-v, --verbose BOOLEAN Show verbose information
--help Show this message and exit.
```
## list
```
Usage: dotconfig list [OPTIONS]
Options:
--help Show this message and exit.
```
## push
```
Usage: dotconfig push [OPTIONS]
Options:
-v, --verbose BOOLEAN Show verbose information
--help Show this message and exit.
```
## status
```
Usage: dotconfig status [OPTIONS]
Options:
-v, --verbose BOOLEAN Show verbose information
-u, --show-untracked Show untracked files
-m, --show-modified Show modified files
-d, --show-deleted Show deleted files
--help Show this message and exit.
```