diff --git a/README.Rmd b/README.Rmd
index 8748837..03532e3 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -16,12 +16,12 @@ knitr::opts_chunk$set(
# oscarr
-
-The goal of `oscarr` is to provide an R wrapper to `pyoscar` python module that provide an easy access to WMO OSCAR REST API. In other words, the package `oscarr` brings pyoscar to R Community.
+
+The goal of `oscarr` is to provide an R wrapper to [pyoscar](https://github.com/wmo-cop/pyoscar "https://github.com/wmo-cop/pyoscar") python module that provide an easy access to WMO OSCAR REST API. In other words, the package `oscarr` brings [pyoscar](https://github.com/wmo-cop/pyoscar "https://github.com/wmo-cop/pyoscar") to R Community.
-## Installation
+# Installation
You can install the development version of oscarr from [GitHub](https://github.com/) with:
@@ -29,6 +29,7 @@ You can install the development version of oscarr from [GitHub](https://github.c
# install.packages("devtools")
devtools::install_github("oousmane/oscarr")
```
+
The following code set up an virtual environment for python dependencies
``` r
@@ -41,7 +42,8 @@ reticulate::use_virtualenv(my_env) # force reticulate to use my_env
# install pyoscar in environment
oscarr::install_pyoscar(my_env)
```
-## Example
+
+# Example
This is a basic example which shows you how to use `oscarr`:
@@ -62,4 +64,3 @@ You can add further constrains to the query
## Add further constrains to station query
get_stations(program = "GBON",country = "BFA", station_type = "landFixed")
```
-
diff --git a/README.md b/README.md
index e749f3e..02ce442 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,16 @@
-
# oscarr
+
-The goal of `oscarr` is to provide an R wrapper to `pyoscar` python
-module that provide an easy access to WMO OSCAR REST API. In other
-words, the package `oscarr` brings pyoscar to R Community.
+The goal of `oscarr` is to provide an R wrapper to [pyoscar](https://github.com/wmo-cop/pyoscar "https://github.com/wmo-cop/pyoscar") python module that provide an easy access to WMO OSCAR REST API. In other words, the package `oscarr` brings [pyoscar](https://github.com/wmo-cop/pyoscar "https://github.com/wmo-cop/pyoscar") to R Community.
-## Installation
+# Installation
-You can install the development version of oscarr from
-[GitHub](https://github.com/) with:
+You can install the development version of oscarr from [GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
@@ -33,7 +30,7 @@ reticulate::use_virtualenv(my_env) # force reticulate to use my_env
oscarr::install_pyoscar(my_env)
```
-## Example
+# Example
This is a basic example which shows you how to use `oscarr`:
diff --git a/docs/index.html b/docs/index.html
index 1329ee5..5a82df7 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -62,10 +62,11 @@
-
The goal of oscarr is to provide an R wrapper to pyoscar python module that provide an easy access to WMO OSCAR REST API. In other words, the package oscarr brings pyoscar to R Community.
-
-
Installation
-
+
The goal of oscarr is to provide an R wrapper to pyoscar python module that provide an easy access to WMO OSCAR REST API. In other words, the package oscarr brings pyoscar to R Community.
+
+
+
Installation
+
You can install the development version of oscarr from GitHub with: