Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
uiolee committed Jun 26, 2024
1 parent 8429915 commit 12850ea
Showing 1 changed file with 28 additions and 5 deletions.
33 changes: 28 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# ezon-gpx

[![CI](https://github.com/uiolee/ezon-gpx/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/uiolee/ezon-gpx/actions/workflows/ci.yml)
[![Publish](https://github.com/uiolee/ezon-gpx/actions/workflows/publish.yml/badge.svg?branch=main)](https://github.com/uiolee/ezon-gpx/actions/workflows/publish.yml)

converter for Ezon gpx file.

## Feat
Expand All @@ -12,22 +15,42 @@ convert Ezon gpx files

## Usage

### Source
![PyPI - Version](https://img.shields.io/pypi/v/ezon-gpx)
![PyPI - Status](https://img.shields.io/pypi/status/ezon-gpx)
![PyPI - Implementation](https://img.shields.io/pypi/implementation/ezon-gpx)
![PyPI - Format](https://img.shields.io/pypi/format/ezon-gpx)
![PyPI - Wheel](https://img.shields.io/pypi/wheel/ezon-gpx)
![PyPI - License](https://img.shields.io/pypi/l/ezon-gpx)
![PyPI - Downloads](https://img.shields.io/pypi/dm/ezon-gpx)

#### Python
### pipx

see [./src/main.py](./src/main.py#L141)
#### Install

#### CLI
```bash
pipx install ezon-gpx
```

####

```bash
./src/cli.py test/test.gpx [path]
ezon-gpx -h
```

### source

#### Python

see [./src/main.py](./src/main.py#L141) for more.

#### CLI

```bash
./src/cli.py --help
```

see [./src/cli.py](./src/cli.py) for more.

## Develop Env

```plain
Expand Down

0 comments on commit 12850ea

Please sign in to comment.