From b3ea3da54f4a43a45f1021db45d248bccb7261f7 Mon Sep 17 00:00:00 2001 From: Deepak Mallubhotla Date: Mon, 28 Mar 2022 19:31:06 -0500 Subject: [PATCH] doc: better README --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index caadd9b..dab3ff0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ -# pyewjn - -python port of `nam_analysis` +# pyewjn + +[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-green.svg?style=flat-square)](https://conventionalcommits.org) +[![PyPI](https://img.shields.io/pypi/v/pyewjn?style=flat-square)](https://pypi.org/project/pyewjn/) +[![Jenkins](https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fjenkins.deepak.science%2Fjob%2Fgitea-physics%2Fjob%2Fpyewjn%2Fjob%2Fmaster&style=flat-square)](https://jenkins.deepak.science/job/gitea-physics/job/pyewjn/job/master/) +![Jenkins tests](https://img.shields.io/jenkins/tests?compact_message&jobUrl=https%3A%2F%2Fjenkins.deepak.science%2Fjob%2Fgitea-physics%2Fjob%2Fpyewjn%2Fjob%2Fmaster%2F&style=flat-square) +![Jenkins Coverage](https://img.shields.io/jenkins/coverage/cobertura?jobUrl=https%3A%2F%2Fjenkins.deepak.science%2Fjob%2Fgitea-physics%2Fjob%2Fpyewjn%2Fjob%2Fmaster%2F&style=flat-square) +![Maintenance](https://img.shields.io/maintenance/yes/2022?style=flat-square) + +python port of `nam_analysis` + +## Getting started + +`poetry install` to start locally + +Commit using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), and when commits are on master, release with `doo release`.