Skip to content

Commit

Permalink
README.md modification (#81)
Browse files Browse the repository at this point in the history
* doc : TOC removed

* doc : badges section updated

* doc : CI badges bug fixed

* doc : AUTHORS.md updated

* doc : title updated
  • Loading branch information
sepandhaghighi authored Jul 3, 2024
1 parent f339368 commit 367a9db
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 29 deletions.
7 changes: 3 additions & 4 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -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)

33 changes: 8 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,13 @@
<div align="center">
<img src="https://github.com/sepandhaghighi/nafas/raw/master/otherfiles/logo.png" width=320px>
<hr/>
<h1>Nafas</h1>

<h1>Nafas: A Breathing Gymnastics Application</h1>
<hr>
<a href="https://badge.fury.io/py/nafas"><img src="https://badge.fury.io/py/nafas.svg" alt="PyPI version" height="18"></a>
<a href="https://codecov.io/gh/sepandhaghighi/nafas">
<img src="https://codecov.io/gh/sepandhaghighi/nafas/branch/master/graph/badge.svg" alt="Codecov" /></a>
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3" /></a>
<a href="https://discord.gg/CtZUNKJHP4">
<img src="https://img.shields.io/discord/901570530145107978.svg" alt="Discord Channel">
</a>
<a href="https://codecov.io/gh/sepandhaghighi/nafas"><img src="https://codecov.io/gh/sepandhaghighi/nafas/branch/master/graph/badge.svg" alt="Codecov"></a>
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3"></a>
<a href="https://discord.gg/CtZUNKJHP4"><img src="https://img.shields.io/discord/901570530145107978.svg" alt="Discord Channel"></a>
</div>

----------
## 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.
Expand Down Expand Up @@ -58,8 +41,8 @@ No need to walk away to take a break, just sit comfortably, run Nafas and let th
</tr>
<tr>
<td align="center">CI</td>
<td align="center"><img src="https://github.com/sepandhaghighi/nafas/workflows/CI/badge.svg?branch=master"></td>
<td align="center"><img src="https://github.com/sepandhaghighi/nafas/workflows/CI/badge.svg?branch=dev"></td>
<td align="center"><img src="https://github.com/sepandhaghighi/nafas/actions/workflows/test.yml/badge.svg?branch=master"></td>
<td align="center"><img src="https://github.com/sepandhaghighi/nafas/actions/workflows/test.yml/badge.svg?branch=dev"></td>
</tr>
</table>

Expand Down

0 comments on commit 367a9db

Please sign in to comment.