diff --git a/README.rst b/README.rst index 16e1b54079..268f1f29e1 100644 --- a/README.rst +++ b/README.rst @@ -78,7 +78,7 @@ EODAG is available on `PyPI `_: .. code-block:: bash - python -m pip install eodag + pip install eodag And with ``conda`` from the `conda-forge channel `_: @@ -88,9 +88,8 @@ And with ``conda`` from the `conda-forge channel `_ **in v3.0.0**: Please note that EODAG comes with a minimal set of dependencies. If you want more features, please install using one of the `available extras `_. @@ -127,15 +126,6 @@ This will search for Sentinel 2 level-1C products on the default provider and re an estimated total number of products matching the search criteria. And then it will download these products. Please check the `Python API User Guide `_ for more details. -.. - - [!IMPORTANT] - - `Breaking change `_ **in v3.0.0**: - `search() `_ method now returns - only a single ``SearchResult`` instead of a 2 values tuple. - - Command line interface ---------------------- @@ -147,7 +137,7 @@ Start playing with the CLI: The request above searches for ``S2_MSI_L1C`` collections in a given bounding box, in March 2021. It saves the results in a GeoJSON file (``search_results.geojson`` by default). - Results are paginated, you may want to get all pages at once with ``--all``, or search products having 20% of maximum coud cover with ``--cloudCover 20``. For more information on available options:: + Results are paginated, you may want to get all pages at once with ``--all``, or search products having 20% of maximum coud cover with ``--cloud-cover 20``. For more information on available options:: eodag search --help @@ -184,7 +174,7 @@ Don't hesitate and open an issue or submit a pull request, contributions are mos For guidance on setting up a development environment and how to make a contribution to eodag, see the `contributing guidelines`_. -.. _contributing guidelines: https://github.com/CS-SI/eodag/blob/develop/CONTRIBUTING.rst +.. _contributing guidelines: https://eodag.readthedocs.io/en/latest/contribute.html License