siar-client 0.0.1 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +27 -8
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2,18 +2,37 @@
2
2
 
3
3
  ## What is this?
4
4
 
5
- A client for the [SIAR platform](https://servicio.mapa.gob.es/websiar/Inicio.aspx) to ease the use of it written in typescript.
5
+ A TypeScript client for the [SIAR platform](https://servicio.mapa.gob.es/websiar/Inicio.aspx) (Sistema de Información Agroclimática para el Regadío) that provides easy access to agricultural climate data from Spain.
6
6
 
7
- # How do I install it?
7
+ For all the specifications, see [SIAR platform](https://servicio.mapa.gob.es/websiar/Inicio.aspx).
8
8
 
9
- Working on it...
9
+ ## Features
10
10
 
11
- It is planned to provide it through npm.
11
+ - Get information about stations, provinces, and autonomous communities.
12
+ - Fetch hourly, daily, weekly, and monthly agricultural climate data
13
+ - Fully typed with TypeScript.
14
+ - Promise-based API.
15
+ - Minimal dependencies.
12
16
 
13
- # How do I use it?
17
+ ## Installation
14
18
 
15
- Working on it...
19
+ ```bash
20
+ npm i siar-client
21
+ ```
16
22
 
17
- # What’s supported?
23
+ # Usage
18
24
 
19
- Working on it...
25
+ See [examples](./docs/EXAMPLES.md).
26
+
27
+ ## License
28
+
29
+ ISC
30
+
31
+ ## Repository
32
+
33
+ - [Github](https://github.com/JulioDoAr/siar-client)
34
+ - [NPM](https://www.npmjs.com/package/siar-client)
35
+
36
+ ## Author
37
+
38
+ Julio Domínguez Arjona
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "siar-client",
3
- "version": "0.0.1",
3
+ "version": "0.1.1",
4
4
  "description": "A client for SIAR system",
5
5
  "keywords": [
6
6
  "SIAR"