Skip to content

Commit

Permalink
Minor edits (#42)
Browse files Browse the repository at this point in the history
* doc : pypi badge height bug fixed

* doc : warning --> info

* doc : AUTHORS.md updated

* fix : coffee beans --> coffee bean

* doc : minor bug in README.md fixed

* fix : keywords updated
  • Loading branch information
sepandhaghighi authored Nov 24, 2024
1 parent 547660c commit b2bc090
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 9 deletions.
1 change: 1 addition & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
# Other Contributors
----------
- [@boreshnavard](https://github.com/boreshnavard) **
- [@AHReccese](https://github.com/AHReccese)


** Graphic designer
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
<h1>MyCoffee: Brew Perfect Coffee Right from Your Terminal</h1>
<br/>
<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://badge.fury.io/py/mycoffee"><img src="https://badge.fury.io/py/mycoffee.svg" alt="PyPI version" height="18"></a>
<a href="https://badge.fury.io/py/mycoffee"><img src="https://badge.fury.io/py/mycoffee.svg" alt="PyPI version"></a>
<a href="https://codecov.io/gh/sepandhaghighi/mycoffee" ><img src="https://codecov.io/gh/sepandhaghighi/mycoffee/graph/badge.svg?token=ZelznFDSPA"></a>
</div>
## Overview

<p align="justify">
<strong>MyCoffee</strong> is a command-line tool for coffee enthusiasts who love brewing with precision. It helps you calculate the perfect coffee-to-water ratio for various brewing methods, ensuring you brew your ideal cup every timeright from your terminal.
<strong>MyCoffee</strong> is a command-line tool for coffee enthusiasts who love brewing with precision. It helps you calculate the perfect coffee-to-water ratio for various brewing methods, ensuring you brew your ideal cup every time-right from your terminal.
</p>

<table>
Expand Down Expand Up @@ -64,7 +64,7 @@

## Usage

⚠️ You can use `mycoffee` or `python -m mycoffee` to run this program
ℹ️ You can use `mycoffee` or `python -m mycoffee` to run this program

### Version

Expand Down Expand Up @@ -103,9 +103,9 @@ Info: V60 method

### Customize

⚠️ You can run `mycoffee --coffee-units-list` to view the supported coffee units
ℹ️ You can run `mycoffee --coffee-units-list` to view the supported coffee units

⚠️ You can run `mycoffee --water-units-list` to view the supported water units
ℹ️ You can run `mycoffee --water-units-list` to view the supported water units

```shell
> mycoffee --method=chemex --water=20 --cups=3 --coffee-ratio=2 --water-ratio=37 --coffee-unit=g --water-unit=g
Expand Down
2 changes: 1 addition & 1 deletion mycoffee/params.py
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@
"lb": {"name": "pound", "rate": 0.00220462262185},
"mg": {"name": "milligram", "rate": 1000},
"kg": {"name": "kilogram", "rate": 0.001},
"cb": {"name": "coffee beans", "rate": 7.5471698},
"cb": {"name": "coffee bean", "rate": 7.5471698},
"tbsp": {"name": "tablespoon", "rate": 0.18528},
"tsp": {"name": "teaspoon", "rate": 0.55585},
"dsp": {"name": "dessertspoon", "rate": 0.27792},
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ def read_description():
author_email='[email protected]',
url='https://github.com/sepandhaghighi/mycoffee',
download_url='https://github.com/sepandhaghighi/mycoffee/tarball/v0.7',
keywords="python3 python ratio coffee terminal",
keywords="coffee ratio terminal brew cli",
project_urls={
'Source': 'https://github.com/sepandhaghighi/mycoffee'
},
Expand Down
4 changes: 2 additions & 2 deletions test/functions_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@
>>> show_coffee_units_list()
Coffee units list:
<BLANKLINE>
1. `cb` - coffee beans
1. `cb` - coffee bean
2. `cup` - cup
3. `dsp` - dessertspoon
4. `g` - gram
Expand Down Expand Up @@ -382,7 +382,7 @@
>>> run(args)
Coffee units list:
<BLANKLINE>
1. `cb` - coffee beans
1. `cb` - coffee bean
2. `cup` - cup
3. `dsp` - dessertspoon
4. `g` - gram
Expand Down

0 comments on commit b2bc090

Please sign in to comment.