Skip to content

Commit

Permalink
Add badges to the README (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
nh13 authored Jun 6, 2020
1 parent 64b9888 commit b60088c
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,41 @@

[![Language][language-badge]][language-link]
[![Code Style][code-style-badge]][code-style-link]
[![Type Checked][type-checking-badge]][type-checking-link]
[![PEP8][pep-8-badge]][pep-8-link]
[![License][license-badge]][license-link]

---

[![Python package][python-package-badge]][python-package-link]
[![PyPI version][pypi-badge]][pypi-link]
[![PyPI download total][pypi-downloads-badge]][pypi-downloads-link]

---

[language-badge]: http://img.shields.io/badge/language-python-brightgreen.svg
[language-link]: http://www.python.org/
[code-style-badge]: https://img.shields.io/badge/code%20style-black-000000.svg
[code-style-link]: https://black.readthedocs.io/en/stable/
[type-checking-badge]: http://www.mypy-lang.org/static/mypy_badge.svg
[type-checking-link]: http://mypy-lang.org/
[pep-8-badge]: https://img.shields.io/badge/code%20style-pep8-brightgreen.svg
[pep-8-link]: https://www.python.org/dev/peps/pep-0008/
[license-badge]: http://img.shields.io/badge/license-MIT-blue.svg
[license-link]: https://github.com/fulcrumgenomics/pyfgaws/blob/master/LICENSE
[python-package-badge]: https://github.com/fulcrumgenomics/pyfgaws/workflows/Python%20package/badge.svg
[python-package-link]: https://github.com/fulcrumgenomics/pyfgaws/actions?query=workflow%3A%22Python+package%22
[pypi-badge]: https://badge.fury.io/py/pyfgaws.svg
[pypi-link]: https://pypi.python.org/pypi/pyfgaws
[pypi-downloads-badge]: https://img.shields.io/pypi/dm/pyfgaws
[pypi-downloads-link]: https://pypi.python.org/pypi/pyfgaws

# pyfgaws

`pip install pyfgaws`

**Requires python 3.8**

# Getting Setup

Conda is used to install a specific version of python and [poetry](https://github.com/python
Expand All @@ -18,4 +54,4 @@ conda activate pyfgaws
poetry install
```

[miniconda-link]: https://docs.conda.io/en/latest/miniconda.html
[miniconda-link]: https://docs.conda.io/en/latest/miniconda.html

0 comments on commit b60088c

Please sign in to comment.