Skip to content

Commit

Permalink
Updated Documentation:
Browse files Browse the repository at this point in the history
- Added a discription for PyPI
  • Loading branch information
anevis committed Apr 6, 2024
1 parent 22f7d80 commit 29c4d55
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# YAML to Markdown Converter

A Python utility to take a JSON / YAML file or a python dict / list and create a Markdown file.
A Python utility to take a JSON / YAML file or a python dict and create a Markdown file.

## Usage

Expand Down Expand Up @@ -39,12 +39,12 @@ You can also use the command line interface to convert a JSON or YAML file to Ma

#### Convert a JSON file to Markdown:
```bash
python yaml_to_markdown/convert.py --output-file output.md --json-file test.json
yaml-to-markdown --output-file output.md --json-file test.json
```

#### Convert a YAML file to Markdown:
```bash
python yaml_to_markdown/convert.py --output-file output.md --yaml-file test.yaml
yaml-to-markdown --output-file output.md --yaml-file test.yaml
```

## Developer Guide
Expand Down
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
setup(
name="yaml-to-markdown",
version=f"0.1.{ts}",
description="Converts a YAML/JSON file or python Dict to a Markdown file",
packages=find_packages(where="src"),
package_dir={"": "src"},
url="https://anevis.github.io/yaml-to-markdown/",
Expand Down

0 comments on commit 29c4d55

Please sign in to comment.