Oppdatert readme
[yr-temp.sh] / README.md
index 9aef5db673a2ac4ac0a2e8f2f3106aec5c81219b..2f2402f8170a3089338116a65466ceb4326c7b95 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,33 @@
 yr-temp.sh
 ==========
 
 yr-temp.sh
 ==========
 
-Et raskt, lite script for å lese av nyeste temperaturmåling for et 
+Et raskt, lite bash-script for å lese av nyeste temperaturmåling for et 
 gitt norsk stedsnavn.
 gitt norsk stedsnavn.
+
+Skrevet av Einar Jørgen Haraldseid <einarjh> for bruk på IRC-kanalen 
+#kopweb på EFNet.
+
+EKSEMPEL
+--------
+    ./yr-temp.sh Rena
+    Temperatur for Rena er ca. 11°C (Observasjon fra Rena (Haugedalen) målestasjon kl. 02.00) - Værvarsel fra yr.no, levert av NRK og Meteorologisk institutt (http://www.yr.no/sted/Norge/Hedmark/Åmot/Rena/varsel.xml)
+
+LISENS
+------
+
+Koden er utgitt under [WTFPL](http://sam.zoy.org/wtfpl/COPYING).
+
+Værdata er levert av [NRK og Meteorologisk institutt](http://www.yr.no).
+
+INSTALLASJON
+------------
+
+Ingen installasjon nødvendig, men koden er avhengig av at xmlstarlet er
+installert på forhånd.
+
+BUGS
+----
+
+ * I koden konverterer jeg input-variablene til lowercase for enklere søking,
+men konverteringen fungerer ikke på særnorske tegn. Så stedsnavn som Ørsta
+og lignende fungerer dårlig per nå.