Fix Readme #1
1 changed files with 8 additions and 17 deletions
25
README.md
25
README.md
|
@ -1,10 +1,7 @@
|
|||
Bärneruhr
|
||||
=========
|
||||
|
||||
# Bärneruhr
|
||||
Du willst Bärneruhr auf deiner Website verwenden? Dank des jQuery-Plugins geht das so einfach, dass es sogar deine Grossmutter tun könnte!
|
||||
|
||||
1. Benötigte Dateien einbinden
|
||||
------------------------------
|
||||
## 1. Benötigte Dateien einbinden
|
||||
* Binde folgende CSS-Datei im HTML-Dokument ein:
|
||||
* dist/uhr.min.css
|
||||
* Binde zusätzlich mindestens eine der folgenden CSS-Dateien im HTML ein, je nach dem, welche Farben deine Uhr unterstützen soll:
|
||||
|
@ -50,16 +47,14 @@ Je nach dem, in welchen Sprachen du die Uhr verwenden willst, noch eine der folg
|
|||
|
||||
`src/uhr-de_CH_genau.js` ist eine Variante von Bärndütsch, bei der zur vollen Stunde zusätzlich das Wort "genau" angezeigt wird (also z.B. um 15:00 Uhr "ES ISCH GENAU DRÜ" anstelle von "ES ISCH DRÜ").
|
||||
|
||||
2. Uhr-Element im HTML-Dokument einfügen
|
||||
----------------------------------------
|
||||
## 2. Uhr-Element im HTML-Dokument einfügen
|
||||
Erstelle ein leeres `<div>` mit einer ID:
|
||||
|
||||
```html
|
||||
<div id="uhrcontainer"></div>
|
||||
```
|
||||
|
||||
3. Uhr per Javascript konfigurieren
|
||||
-----------------------------------
|
||||
## 3. Uhr per Javascript konfigurieren
|
||||
Initialisiere die Uhr mit einer einzigen Zeile Javascript:
|
||||
|
||||
```javascript
|
||||
|
@ -88,8 +83,7 @@ jQuery('div').uhr();
|
|||
|
||||
würde also jedes `<div>`-Element der Seite in eine Uhr umgewandelt.
|
||||
|
||||
4. Weitere Optionen
|
||||
-------------------
|
||||
## 4. Weitere Optionen
|
||||
Der uhr()-Methode kann ein Options-Objekt mitgegeben werden:
|
||||
|
||||
```javascript
|
||||
|
@ -110,8 +104,7 @@ jQuery('#uhrcontainer').uhr({
|
|||
});
|
||||
```
|
||||
|
||||
5. Sonderfunktionen
|
||||
-------------------
|
||||
## 5. Sonderfunktionen
|
||||
Es gibt noch einen zusätzlichen Konfigurationsparameter. Mittels
|
||||
|
||||
```javascript
|
||||
|
@ -127,8 +120,7 @@ Die Zeit kann auch über einen Methodenaufruf dynamisch eingestellt werden:
|
|||
jQuery('#uhrcontainer').uhr("time", new Date());
|
||||
```
|
||||
|
||||
6. Konfiguration über die URL
|
||||
-----------------------------
|
||||
## 6. Konfiguration über die URL
|
||||
Es ist möglich, die Uhr durch den Aufruf mit URL-Parameters zu konfigurieren. Dies übersteuert auch allfällig bereits in einem Cookie gespeicherte Einstellungen. Die Einstellungen werden für alle Uhr-Elemente übernommen, welche sich auf der Seite befinden. Folgende Parameter werden unterstützt, wenn du sie mit einem Hash (`#`) an die URL anhängst:
|
||||
|
||||
* `l` oder `language`: Bestimmt die Sprache. Der Wert ist der Sprach-Code (abhängig von den eingebundenen Sprachdateien):
|
||||
|
@ -165,8 +157,7 @@ Dies zeigt dann die Uhr auf Französisch in Rot, im Sekunden-Modus und eingescha
|
|||
|
||||
Viel Spass!
|
||||
|
||||
A. Lizenzbestimmungen
|
||||
=====================
|
||||
# A. Lizenzbestimmungen
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
|
|
Loading…
Reference in a new issue