Skip to content

Commit a56e3c3

Browse files
committed
replace README.rst -> README.md
1 parent 9dead7a commit a56e3c3

File tree

2 files changed

+10
-18
lines changed

2 files changed

+10
-18
lines changed

README.rst renamed to README.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,11 @@
1-
================
2-
grdwindinversion
3-
================
41

2+
# grdwindinversion
53

6-
.. image:: https://img.shields.io/pypi/v/grdwindinversion.svg
7-
:target: https://pypi.python.org/pypi/grdwindinversion
84

9-
.. image:: https://img.shields.io/travis/agrouaze/grdwindinversion.svg
10-
:target: https://travis-ci.com/agrouaze/grdwindinversion
115

12-
.. image:: https://readthedocs.org/projects/grdwindinversion/badge/?version=latest
13-
:target: https://grdwindinversion.readthedocs.io/en/latest/?version=latest
14-
:alt: Documentation Status
6+
[![Python Version](https://img.shields.io/pypi/pyversions/grdwindinversion.svg)](https://pypi.org/project/grdwindinversion/)
7+
[![Dependencies Status](https://img.shields.io/badge/dependencies-up%20to%20date-brightgreen.svg)](https://github.com/umr-lops/grdwindinversion/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)
8+
159

1610

1711

@@ -23,10 +17,10 @@ Package to perform Wind inversion from GRD Level-1 SAR images
2317
* Documentation: https://grdwindinversion.readthedocs.io.
2418

2519

26-
Usage
27-
------
20+
## Usage
21+
2822

29-
.. code-block:: python
23+
```python
3024

3125
SAR_L1-to-L2_wind_processor -h
3226
usage: SAR_L1-to-L2_wind_processor [-h] --input_file INPUT_FILE [--config_file CONFIG_FILE] --outputdir OUTPUTDIR [--verbose] [--overwrite]
@@ -42,11 +36,10 @@ Usage
4236
--outputdir OUTPUTDIR
4337
--verbose
4438
--overwrite overwrite existing .nc files [default is False]
39+
```
4540

4641

47-
48-
Features
49-
--------
42+
## Features
5043

5144
This Python library (based on `xarray`) allows to perform wind inversion from level-1 GRD (projected magnitude image).
5245
Mission supported:

pyproject.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
name = "grdwindinversion"
33
requires-python = ">= 3.9"
44
description = "Package to perform Wind inversion from GRD Level-1 SAR images"
5-
readme.file = "README.rst"
6-
readme.content-type = "text/x-rst"
5+
readme = "README.md"
76
license = {text = "MIT"}
87
dependencies = [
98
"xsar",

0 commit comments

Comments
 (0)