Skip to content

Commit

Permalink
docs: improve README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
leynier committed Oct 23, 2021
1 parent 73155d9 commit 67a132f
Showing 1 changed file with 48 additions and 1 deletion.
49 changes: 48 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# CLI for unasync


[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
[![Test](https://github.com/leynier/unasync-cli/workflows/CI/badge.svg)](https://github.com/leynier/unasync-cli/actions?query=workflow%3ACI)
[![codecov](https://codecov.io/gh/leynier/unasync-cli/branch/main/graph/badge.svg?token=Z1MEEL3EAB)](https://codecov.io/gh/leynier/unasync-cli)
Expand All @@ -17,6 +16,54 @@

Command line interface for unasync

## Getting started

### Install

Run the following command to install the package with [pip](https://pip.pypa.io):

```bash
pip install unasync-cli
```

Or with [conda](https://conda.io):

```bash
conda install unasync-cli
```

Or with [poetry](https://python-poetry.org):

```bash
poetry add unasync-cli --dev
```

Or any other package manager you prefer.

### Usage

For usage information, run the following command:

```bash
unasync --help
```

```txt
Usage: unasync [OPTIONS] PATHS...
Arguments:
PATHS... The folders where it will check for folders with the name _async
to generate its equivalent _sync. [required]
Options:
--install-completion [bash|zsh|fish|powershell|pwsh]
Install completion for the specified shell.
--show-completion [bash|zsh|fish|powershell|pwsh]
Show completion for the specified shell, to
copy it or customize the installation.
--help Show this message and exit.
```

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Expand Down

0 comments on commit 67a132f

Please sign in to comment.