add explanation for users who do not want support for jupyter notebooks

bndr · Nov 27, 2023 · 25b1722 · 25b1722
1 parent 530548a
commit 25b1722
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -25,6 +25,14 @@ Installation
 
     pip install pipreqs
 
+Obs.: if you don't want support for jupyter notebooks, you can install pipreqs without the dependencies that give support to it. 
+To do so, run:
+
+.. code-block:: sh
+
+    pip install --no-deps pipreqs
+    pip install yarg==0.1.9 docopt==0.6.2
+
 Usage
 -----
 
@@ -57,6 +65,7 @@ Usage
                               <compat> | e.g. Flask~=1.1.2
                               <gt>     | e.g. Flask>=1.1.2
                               <no-pin> | e.g. Flask
+        --scan-notebooks      Look for imports in jupyter notebook files.
 
 Example
 -------