Skip to content

Commit 1a13f7e

Browse files
committed
Updated readme
1 parent 62bf1bd commit 1a13f7e

2 files changed

Lines changed: 10 additions & 2 deletions

File tree

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,13 @@
44
[![GitHub forks](https://img.shields.io/github/forks/devanshkv/argmark?style=flat-square)](https://github.com/devanshkv/argmark/forks)
55
[![GitHub stars](https://img.shields.io/github/stars/devanshkv/argmark?style=flat-square)](https://github.com/devanshkv/argmark/stars)
66
[![GitHub LICENSE](https://img.shields.io/github/license/devanshkv/argmark?style=flat-square)](https://github.com/devanshkv/argmark/LICENSE)
7+
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/argmark?style=flat-square)](https://pypi.org/project/argmark)
8+
[![PyPI](https://img.shields.io/pypi/v/argmark?style=flat-square)](https://pypi.org/project/argmark)
9+
710
[![codecov](https://codecov.io/gh/devanshkv/argmark/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/devanshkv/argmark)
811

912

10-
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.
13+
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.
1114
### Installation
1215
```bash
1316
pip install argmark

setup.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
from setuptools import setup
22

3-
with open("requirements.txt") as f:
3+
with open("requirements.txt", "r") as f:
44
required = f.read().splitlines()
55

6+
with open("README.md", "r") as f:
7+
long_description = f.read()
8+
69
setup(
710
name="argmark",
811
version="0.1",
912
packages=["argmark"],
1013
url="https://github.com/devanshkv/argmark",
1114
install_requires=required,
15+
long_description=long_description,
16+
long_description_content_type="text/markdown",
1217
author="Devansh Agarwal",
1318
author_email="devansh.kv@gmail.com",
1419
description="Convert argparse based executable scripts to markdown documents.",

0 commit comments

Comments
 (0)