Skip to content

Commit 49cce57

Browse files
committed
Update of the documentation
1 parent ddb00e7 commit 49cce57

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

docs/installation/get-domain2idna.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,20 @@ Using :code:`pip`
66

77
Choose your repository, install and enjoy domain2idna!
88

9+
From PyPi
10+
""""""""""
11+
12+
::
13+
14+
$ pip3 install --user domain2idna
15+
16+
.. note::
17+
We recommend the :code:`--user` flag which installs the required dependencies at the user level. More information about it can be found on `pip documentation`_.
18+
.. warning::
19+
We do not recommend the :code:`--user` flag when using :code:`domain2idna` into containers like - for example - Travis CI.
20+
21+
.. _pip documentation: https://pip.pypa.io/en/stable/reference/pip_install/?highlight=--user#cmdoption-user
22+
923
From GitHub
1024
"""""""""""
1125

0 commit comments

Comments
 (0)