Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
judahpaul16 committed Apr 27, 2024
1 parent ce27d25 commit 4946f95
Showing 1 changed file with 22 additions and 4 deletions.
26 changes: 22 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# dirconfig 📂
Configure what files should be in what folders using an easy-to-read YAML config file.

![PyPI](https://img.shields.io/pypi/v/dirconfig)
[![PyPI](https://img.shields.io/pypi/v/dirconfig)](https://pypi.org/project/dirconfig/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dirconfig)
![PyPI - License](https://img.shields.io/pypi/l/dirconfig)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/judahpaul16/dirconfig/workflow.yaml)
[![PyPI - License](https://img.shields.io/pypi/l/dirconfig)](LICENSE)
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/judahpaul16/dirconfig/workflow.yaml)](https://github.com/judahpaul16/dirconfig/actions)

Configure what files should be in what folders using an easy-to-read YAML config file.

## Features

Expand Down Expand Up @@ -62,6 +63,23 @@ To run **dirconfig** as a separate process, use the following command:
dirconfig start &
```

### Command Line Options
```sh
usage: dirconfig [-h] [--config CONFIG] [--log LOG] [--pid PID] {start,stop,generate}
dirconfig Daemon
positional arguments:
{start,stop,generate}
Dirconfig actions to perform
options:
-h, --help show this help message and exit
--config CONFIG Path to the configuration file
--log LOG Path to the log file
--pid PID Path to the PID file
```

### Stopping dirconfig

To stop the **dirconfig** daemon, execute:
Expand Down

0 comments on commit 4946f95

Please sign in to comment.