docs: update readme

README.md

@@ -1,5 +1,7 @@
 # hkgfinder
 
+*Find housekeeping genes in prokaryotic (meta)genomes*
+
 [![PyPI](https://img.shields.io/pypi/v/hkgfinder.svg)](https://pypi.org/project/hkgfinder)
 [![Wheel](https://img.shields.io/pypi/wheel/hkgfinder.svg)](https://pypi.org/project/hkgfinder)
 [![Language](https://img.shields.io/pypi/implementation/hkgfinder)](https://pypi.org/project/hkgfinder)
@@ -8,24 +10,21 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://www.gnu.org/licenses/MIT)
 
 
-## Find housekeeping genes in prokaryotic (meta)genomes
 
-### Introduction
+
+## 🗺️ Overview
 hkgfinder is a fast and accurate housekeeping gene finder and classifier. hkgfinder can run on raw sequences, genomes and metagenomes. The novel value of this method lies is in its ability to directly predict and classify gene sequences into housekeeping gene families at a high specificity and sensitivity, while being also faster than genome and metagenome annotator on genome and metagenome data.
 
 
-### How hkgfinder works
+## How hkgfinder works
 ![](img/hkgfinder.png)
 
-### Installation
-
-~~You will have first to install [Prodigal](https://github.com/hyattpd/Prodigal) and [HMMER 3](https://hmmer.org) to be able to run hkgfinder.~~
-
-**hkgfinder since v0.2 is without external dependencies.**
+## 🔧 Installing
 
+hkgfinder can be installed directly from [PyPI](https://pypi.org/project/hkgfinder).
 
-```bash
-pip install hkgfinder
+```console
+$ pip install hkgfinder
 ```
 
 ## Test
@@ -58,12 +57,15 @@ hkgfinder --faa housekeeping.faa --fna housekeeping.fna file.fa.gz
 
 * hkgfinder supports gzip, lzma, bz2 and zstd compressed files.
 
-## Bugs
+## ⚠️ Issue Tracker
 
-Submit problems or requests to the [Issue Tracker](https://github.com/Ebedthan/hkgfinder/issues).
+Found a bug ? Have an enhancement request ? Head over to the [Issue Tracker](https://github.com/Ebedthan/hkgfinder/issues) if you need to report
+or ask something. If you are filing in on a bug, please include as much
+information as you can about the issue, and try to recreate the same bug
+in a simple, easily reproducible situation.
 
 
-## Licence
+## ⚖️ License
 
 [MIT](https://github.com/Ebedthan/hkgfinder/blob/main/LICENSE).
 

hkgfinder/hkgfinder.py

@@ -24,7 +24,7 @@
 
 AUTHOR = "Anicet Ebou <[email protected]>"
 URL = "https://github.com/Ebedthan/hkgfinder"
-VERSION = "0.2"
+VERSION = "0.3"
 
 args = cli.args
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "hkgfinder"
-version = "0.2.0"
+version = "0.3.0"
 description = "find housekeeping genes in prokaryotic (meta)genomic data"
 authors = ["Anicet Ebou <[email protected]>"]
 license = "MIT"