From 50c413b6f3c02c63b143ad4abf2e357cf7b2fbb0 Mon Sep 17 00:00:00 2001
From: Charles Cabergs <me@cacharle.xyz>
Date: Sun, 28 Feb 2021 18:46:38 +0100
Subject: Updated README.rst to generate inline image shields

---
 README.md | 39 ++++++++++++++++++++++++++++++++-------
 1 file changed, 32 insertions(+), 7 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 7ca51ef..87c1999 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
-# minishell_test
+# minishell\_test
 
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/minishell-test)](https://pypi.org/project/minishell-test/)
 [![Documentation](https://readthedocs.org/projects/minishell-test/badge/?version=latest)](https://minishell-test.readthedocs.io)
 [![Build Status](https://api.travis-ci.com/cacharle/minishell_test.svg?branch=master)](https://travis-ci.com/cacharle/minishell_test)
 
-Test for 42 school\'s minishell project.
+Test for 42 school's minishell project.
 
 ![preview](https://i.imgur.com/98xh2xY.gif)
 
@@ -12,7 +12,7 @@ Test for 42 school\'s minishell project.
 
 ### Installation
 
-``` {.}
+``` 
 $ pip3 install minishell-test
 $ pip3 install --user minishell-test  # if you don't have root access
 ```
@@ -22,26 +22,51 @@ $ pip3 install --user minishell-test  # if you don't have root access
 Your executable **must** support the `-c` option which allow to pass
 command as string.
 
-``` {.}
+``` 
 $ bash -c 'echo bonjour je suis | cat -e'
 bonjour je suis$
 $ ./minishell -c 'echo bonjour je suis | cat -e'
 bonjour je suis$
 ```
 
+<div class="note">
+
+<div class="title">
+
+Note
+
+</div>
+
 With this setup `argv[2]` is what you would usually get in `line` from
 `get_next_line`.
 
+</div>
+
 ### Usage
 
 Run all the predefined tests:
 
-``` {.}
+``` 
 $ cd <MINISHELL>
 $ minishell_test
 ```
 
+<div class="warning">
+
+<div class="title">
+
+Warning
+
+</div>
+
 If you get `command not found`, do either of those things:
 
--  `~/.local/bin` to your `PATH` environment variable.
--  run `$ python3 -m minishell_test` instead of `$ minishell_test`
+-   `~/.local/bin` to your `PATH` environment variable.
+-   run `$ python3 -m minishell_test` instead of `$ minishell_test`
+
+</div>
+
+## Documentation
+
+The full documentation for this project is available at
+[minishell-test.readthedocs.io](https://minishell-test.readthedocs.io).
-- 
cgit