feat: updated README

CODE_OF_CONDUCT.md

@@ -0,0 +1,131 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at sing [[email protected]](mailto:[email protected]).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

README.md

@@ -1,16 +1,83 @@
-:warning:  **Package under developing**: Can be subjected to any critic change!
+<div align="center">
+    <br>
+    <br>
+    <a href="https://openvariant.readthedocs.io/">
+      <img src="logo_openvariant.png" width="430" height="352">
+    </a>
+    <br>
+    <br>
+  	<a href="https://opensource.org/licenses/BSD-3-Clause">
+  		<img alt="License" src="https://img.shields.io/github/license/bbglab/openvariant">
+  	</a>
+  	<a href="https://pypi.org/project/open-variant/">
+  		<img alt="PyPi" src="https://img.shields.io/pypi/v/open-variant">
+  	</a>
+      <a href="https://github.com/bbglab/openvariant/actions/workflows/openvariant_tester.yml">
+          <img alt="Test" src="https://github.com/bbglab/openvariant/actions/workflows/openvariant_tester.yml/badge.svg">
+      </a>
+  	<a href="https://openvariant.readthedocs.io/en/latest/?badge=latest">
+  		<img alt="Documentation Status" src="https://readthedocs.org/projects/openvariant/badge/?version=latest">
+  	</a>
+    <br>
+    <br>
+</div>
 
-# OpenVariant
-[![License](https://img.shields.io/github/license/bbglab/openvariant)](https://opensource.org/licenses/BSD-3-Clause)
-[![PyPI](https://img.shields.io/pypi/v/open-variant)](https://pypi.org/project/open-variant/)
-[![Test workflow](https://github.com/bbglab/openvariant/actions/workflows/openvariant_tester.yml/badge.svg)](https://github.com/bbglab/openvariant/actions/workflows/openvariant_tester.yml)
-[![Documentation Status](https://readthedocs.org/projects/openvariant/badge/?version=latest)](https://openvariant.readthedocs.io/en/latest/?badge=latest)
+---------------------
 
+OpenVariant is a comprehensive Python package that provides different functionalities to read, parse and operate
+different multiple input file formats (e. g. ``tsv``, ``csv``, ``vcf``, ``maf``, ``bed``), being able to customize the output.
 
-## Install
+Its aim is being able to manage a ton of data represented in multiple ways and be able to build an unified output with 
+a proper annotation file structure. This package was thought to work with any kind of data that can be represented 
+as a table.
+
+_Documentation_: [https://openvariant.readthedocs.io](https://openvariant.readthedocs.io)
+
+## Features
+
+OpenVariant offers a toolkit to transform and operate the parsed input data. We will be able to apply different 
+functionalities on our parsed result some of them are the following ones:
+
+- Find files
+- Read and save
+- Cat
+- Group by
+- Count
+- Command-line interface (CLI)
+- Plugins
+
+<div align="center">
+  <a href="https://openvariant.readthedocs.io/en/latest/user_guide.html">
+    <img src="workflow.gif" width="600" height="352">
+  </a>
+</div>
+
+Check [User guide](https://openvariant.readthedocs.io/en/latest/user_guide.html) in OpenVariant's documentation to find all the information about how it works 
+and how can be applied the different functionalities.  
+
+## Installation
+
+It requires Python 3 or higher and can be installed as [PyPI package](https://pypi.org/project/open-variant/) with:
 
 ```bash
 pip install open-variant
 ```
 
-Check [examples](./examples) for any kind of interest on how to use this package.  
+For more details check our [Installation](https://openvariant.readthedocs.io/en/latest/installation.html) section.
+
+## Examples
+
+We offer a bunch of [Examples](examples) to we be able to understand how OpenVariant can be applied. Also, check 
+[Examples](./examples) section in OpenVariant's documentation.
+
+## Contributing
+
+Feel free to contribute as much as you want to the code.
+
+See [CONTRIBUTING](CONTRIBUTING.md) for guidelines on contributing and respect your behaviour specified
+at [CODE OF CONDUCT](CODE_OF_CONDUCT.md).
+
+## License
+
+The software is licensed under [BSD-3-Clause](LICENSE), and the artworks in the images folder are licensed
+under the [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.txt).