Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
devanshkv committed Aug 19, 2020
1 parent 62bf1bd commit 1a13f7e
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,13 @@
[![GitHub forks](https://img.shields.io/github/forks/devanshkv/argmark?style=flat-square)](https://github.com/devanshkv/argmark/forks)
[![GitHub stars](https://img.shields.io/github/stars/devanshkv/argmark?style=flat-square)](https://github.com/devanshkv/argmark/stars)
[![GitHub LICENSE](https://img.shields.io/github/license/devanshkv/argmark?style=flat-square)](https://github.com/devanshkv/argmark/LICENSE)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/argmark?style=flat-square)](https://pypi.org/project/argmark)
[![PyPI](https://img.shields.io/pypi/v/argmark?style=flat-square)](https://pypi.org/project/argmark)

[![codecov](https://codecov.io/gh/devanshkv/argmark/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/devanshkv/argmark)


Convert argparse based executable scripts to markdown documents. It is based upon [argdown](https://github.com/9999years/argdown) but has a simpler interfaceand a cleaner code.
Convert argparse based executable scripts to markdown documents. It is based on [argdown](https://github.com/9999years/argdown) but has a simpler interfaceand a cleaner code.
### Installation
```bash
pip install argmark
Expand Down
7 changes: 6 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
from setuptools import setup

with open("requirements.txt") as f:
with open("requirements.txt", "r") as f:
required = f.read().splitlines()

with open("README.md", "r") as f:
long_description = f.read()

setup(
name="argmark",
version="0.1",
packages=["argmark"],
url="https://github.com/devanshkv/argmark",
install_requires=required,
long_description=long_description,
long_description_content_type="text/markdown",
author="Devansh Agarwal",
author_email="[email protected]",
description="Convert argparse based executable scripts to markdown documents.",
Expand Down

0 comments on commit 1a13f7e

Please sign in to comment.