diff --git a/README.md b/README.md index 7f66f03..2cffa12 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ -

🍔 What to eat? 🍕

+

🍔 What to eat? 🍕

+

+ CLI tool to query Wolt API in your location! +

![Release](https://github.com/Valaraucoo/what-to-eat/actions/workflows/release.yml/badge.svg) ![Build Status](https://github.com/Valaraucoo/what-to-eat/actions/workflows/tests.yml/badge.svg) [![PyPI](https://img.shields.io/pypi/v/what-to-eat.svg)](https://pypi.python.org/pypi/what-to-eat/) +[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) -

- CLI tool to query Wolt API in your location! -

---- Why to use *what-to-eat*? How many times have you not known what to order for dinner or lunch? *What-to-eat* will help you querying and filtering restaurants available in your location via [Wolt](https://wolt.com/pl/discovery) app! 🍔 Example usage: @@ -18,14 +18,16 @@ Example usage: demo

-

✨ Features

+

✨ Features

* 🍔 Query restaurants in your location * 🍕 Filter restaurants by name, cuisine, price, rating, delivery time, etc. * 🍗 Display restaurant details * 🍟 Random restaurant draw -

🛠️ Installation

+

🛠️ Installation

+ +*What to eat* is compatible with Python 3.10+ and runs on Linux, macOS and Windows. The latest releases with binary wheels are available from pip. Before you install *What to eat* and its dependencies, make sure that your pip, setuptools and wheel are up to date. You can install `what-to-eat` using [pip](https://pypi.org/project/what-to-eat/): @@ -33,7 +35,7 @@ You can install `what-to-eat` using [pip](https://pypi.org/project/what-to-eat/) pip install what-to-eat ``` -

💬 Available commands

+

💬 Available commands

There are currently 3 commands available, one of which is used to configure the tool: `configure`, `ls`, `random`: @@ -59,7 +61,7 @@ $ what-to-eat --help You can find examples of using these commands in the section below. -

✨ Examples

+

✨ Examples

Configure your tool: ```console @@ -153,6 +155,6 @@ You can select one of the following techniques: - `delivery_time` - the restaurant will be selected based on the delivery time. - `random` - the restaurant will be selected randomly. -

📚 License

+

📚 License

This project is licensed under the terms of the MIT license.