From 367a9db783932e448f3867ed1cd013a90e0865cd Mon Sep 17 00:00:00 2001 From: Sepand Haghighi Date: Wed, 3 Jul 2024 19:00:41 +0330 Subject: [PATCH] `README.md` modification (#81) * doc : TOC removed * doc : badges section updated * doc : CI badges bug fixed * doc : AUTHORS.md updated * doc : title updated --- AUTHORS.md | 7 +++---- README.md | 33 ++++++++------------------------- 2 files changed, 11 insertions(+), 29 deletions(-) diff --git a/AUTHORS.md b/AUTHORS.md index 886e097..feaa74d 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -1,6 +1,5 @@ -# Core Developers # - +# Core Developers ---------- -- Sepand Haghighi - Sharif University of Technology - ([@sepandhaghighi](http://github.com/sepandhaghighi)) ([sepand@pyrgg.ir](mailto:sepand@pyrgg.ir)) -- Sadra Sabouri - Sharif University of Technology - ([@sadrasabouri](https://github.com/sadrasabouri)) ([sadra@pyrgg.ir](mailto:sadra@pyrgg.ir)) +- [@sepandhaghighi](http://github.com/sepandhaghighi) +- [@sadrasabouri](https://github.com/sadrasabouri) diff --git a/README.md b/README.md index f0f485a..a64ad04 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,13 @@
-
-

Nafas

- +

Nafas: A Breathing Gymnastics Application

+
PyPI version - - Codecov -built with Python3 - - Discord Channel - +Codecov +built with Python3 +Discord Channel
- ----------- -## Table of contents - * [Overview](https://github.com/sepandhaghighi/nafas#overview) - * [Installation](https://github.com/sepandhaghighi/nafas#installation) - * [Usage](https://github.com/sepandhaghighi/nafas#usage) - * [Issues & Bug Reports](https://github.com/sepandhaghighi/nafas#issues--bug-reports) - * [Contribution](https://github.com/sepandhaghighi/nafas/blob/master/.github/CONTRIBUTING.md) - * [References](https://github.com/sepandhaghighi/nafas#references) - * [Authors](https://github.com/sepandhaghighi/nafas/blob/master/AUTHORS.md) - * [License](https://github.com/sepandhaghighi/nafas/blob/master/LICENSE) - * [Show Your Support](https://github.com/sepandhaghighi/nafas#show-your-support) - * [Changelog](https://github.com/sepandhaghighi/nafas/blob/master/CHANGELOG.md) - * [Code of Conduct](https://github.com/sepandhaghighi/nafas/blob/master/.github/CODE_OF_CONDUCT.md) + ## Overview Breathing gymnastics is a system of breathing exercises that focuses on the treatment of various diseases and general health promotion. @@ -58,8 +41,8 @@ No need to walk away to take a break, just sit comfortably, run Nafas and let th CI - - + +