Merge pull request #23 from Valaraucoo/develop

🔖 Release version `0.1.8`
Valaraucoo · Dec 3, 2022 · 1b15731 · 1b15731
2 parents 89d2f5c + e2d0730
commit 1b15731
Show file tree

Hide file tree

Showing 6 changed files with 257 additions and 37 deletions.
diff --git a/README.md b/README.md
@@ -1,15 +1,15 @@
-<h2>🍔 What to eat? 🍕</h2>
+<h1>🍔 What to eat? 🍕</h1>
+<p align="center">
+    <em>CLI tool to query Wolt API in your location!</em>
+</p>
 
 ![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)
 
 
-<p align="center">
-    <em>CLI tool to query Wolt API in your location!</em>
-</p>
 
----
 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,22 +18,24 @@ Example usage:
     <img src="https://raw.githubusercontent.com/Valaraucoo/what-to-eat/master/images/ls-query-example.png" alt="demo" width="900"/>
 </p>
 
-<h4>✨ Features </h4>
+<h2>✨ Features </h2>
 
 * 🍔 Query restaurants in your location
 * 🍕 Filter restaurants by name, cuisine, price, rating, delivery time, etc.
 * 🍗 Display restaurant details
 * 🍟 Random restaurant draw
 
-<h3>🛠️ Installation</h3>
+<h2>🛠️ Installation</h2>
+
+*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/):
 
 ```console
 pip install what-to-eat
 ```
 
-<h3>💬 Available commands</h3>
+<h2>💬 Available commands</h2>
 
 There are currently 3 commands available, one of which is used to configure the tool: `configure`, `ls`, `random`:
 
@@ -42,24 +44,24 @@ $ what-to-eat --help
 
  Usage: what-to-eat [OPTIONS] COMMAND [ARGS]...
 
-╭─ Options ────────────────────────────────────────────────────────────────────╮
-│ --install-completion          Install completion for the current shell.      │
-│ --show-completion             Show completion for the current shell, to copy │
-│                               it or customize the installation.              │
-│ --help                        Show this message and exit.                    │
-╰──────────────────────────────────────────────────────────────────────────────╯
-╭─ Commands ───────────────────────────────────────────────────────────────────╮
-│ configure       Create configuration file to your orders                     │
-│ ls              Finds best restaurants via Wolt API                          │
-│ random          Finds random restaurant via Wolt API                         │
-╰──────────────────────────────────────────────────────────────────────────────╯
+╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --version             -v                                                                                                    │
+│ --install-completion            Install completion for the current shell.                                                   │
+│ --show-completion               Show completion for the current shell, to copy it or customize the installation.            │
+│ --help                          Show this message and exit.                                                                 │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ configure                                Create configuration file to your orders                                           │
+│ ls                                       List restaurants queried from Wolt API.                                            │
+│ random                                   Finds random restaurant via Wolt API                                               │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
 
 ```
 
 You can find examples of using these commands in the section below.
 
 
-<h3>✨ Examples</h3>
+<h2>✨ Examples</h2>
 Configure your tool:
 
 ```console
@@ -153,6 +155,14 @@ 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.
 
-<h3>📚 License</h3>
+<h2>📖 Documentation </h2>
+
+| Documentation                                             | Command               | Options                                                |
+|-----------------------------------------------------------|-----------------------|--------------------------------------------------------|
+| [🚀 List all restaurants](./docs/list-all-restaurants.md) | `what-to-eat ls`      | `query`, `profile`, `tag`, `sort`, `ordering`, `limit` |
+| [🎲 Random restaurant](./docs/random.md)                  | `what-to-eat random`  | `profile`, `tag`, `technique`                          |
+| 👤 Configure profile                                      | `what-to-eat config`  |                                                        |
+
+<h2>📚 License</h2>
 
 This project is licensed under the terms of the MIT license.