Merge pull request #11 from xificurk/docs

Dokumentace rozšíření

Author: xificurk

README.md

@@ -1,31 +1,32 @@
+[![Latest Stable Version](https://poser.pugx.org/skautis/nette/v/stable.svg)](https://packagist.org/packages/skautis/nette) [![Total Downloads](https://poser.pugx.org/skautis/nette/downloads.svg)](https://packagist.org/packages/skautis/nette) [![Latest Unstable Version](https://poser.pugx.org/skautis/nette/v/unstable.svg)](https://packagist.org/packages/skautis/nette) [![License](https://poser.pugx.org/skautis/nette/license.svg)](https://packagist.org/packages/skautis/nette)
+
 SkautisNette
-=======
+============
+
+Rozšíření pro [Nette](https://github.com/nette/nette) integrující [PHP knihovnu pro připojení ke SkautISu](https://github.com/skaut/Skautis).
+
+
+# Požadavky
 
-Rozšíření do [Nette](https://github.com/nette/nette) o [PHP knihovnu pro připojení ke Skautisu](https://github.com/skaut/skautis).
+[Nette Framework](https://github.com/nette/nette) verze 2.1 nebo vyšší. Detaily v [composer.json](./composer.json).
 
-# Jak rozšíření připojit?
-Nainstalujte balíček přes composer ``composer require skautis/nette:2.0.*`` a pak už jen stačí zaregistrovat rozšíření(extension) v konfiguračním souboru a nastavit ho.
 
+# Instalace
+
+Nainstalujte balíček přes composer ``composer require skautis/nette:2.0.*``, zaregistrujte a nastavte rozšíření (extension) v konfiguračním souboru.
+
+Ukázka minimální konfigurace:
 ```
 extensions:
-    skautis: SkautIS\Nette\SkautisExtension # yourNameOfExtension : SkautIS\Nette\SkautisExtension
+    skautis: Skautis\Nette\SkautisExtension
 
 skautis:
-    applicationId : abcd-...-abcd #ID_Aplication assigned by skautis administrator
-    testMode : true #using http://test-is.skaut.cz/
-    profiler: true
+    applicationId : abcd-...-abcd # AppId přidělené administrátorem skautISu
 ```
-Ukázkový konfigurační soubor najdete v adresáři repozitáže [src/SkautIS/Nette/config.sample.neon](https://github.com/sinacek/SkautIS/blob/master/src/SkautIS/Nette/config.sample.neon).
-
-Po registraci rozšíření se v testovacím modu Nette automaticky aktivuje skautis panel, který sleduje všechny dotazy na skautis.
 
-![Skautis panel pro ladění aplikace](skautis-panel.png)
 
-Všechny informace o práci s knihovnou najdete na [https://github.com/skaut/skautis](https://github.com/skaut/skautis)
+# Návod na použití
 
-##Co to je composer?
-Composer je balíčkovací systém usnadňující práci s knihovnami, Detailnější informace najdete na [http://getcomposer.org/doc](http://getcomposer.org/doc/)
+Podrobný přehled použití tohoto rozšíření v [dokumentaci](docs/README.md).
 
-* stáhněte composer z [http://getcomposer.com](http://getcomposer.com)
-* pomocí konzole spusťte příkaz ``composer require skautis/nette:2.0.*``
-* pomocí konzole nainstalujte závislosti ``composer install``
+Dokumentaci samotné knihovny najdete na [https://github.com/skaut/Skautis](https://github.com/skaut/Skautis).

docs/README.md

@@ -0,0 +1,8 @@
+# Konfigurace
+
+V konfigurační sekci rozšíření je možné nastavit některé [základní volby](./konfigurace.md) ovlivňující způsob komunikace se SkautISem.
+
+
+# Cache
+
+Knihovna nabízí připravený dekorátor pro cachovaní požadavků na SkautIS, toto rozšíření přidává možnost [cachovat data pomocí `nette/caching`](./cache.md).

docs/cache.md

@@ -0,0 +1,22 @@
+# Cachování požadavků pomocí `nette/caching`
+
+Pro cachování požadavků na SkautIS je možné použít libovolné uložiště z balíčku `nette/caching`.
+
+## Příklad
+
+```php
+// Získáme webovou službu ze skautisu
+$webService = $skautis->User;
+
+// Vytvoříme cache používající zvoleného uložiště
+$cache = new Skautis\Nette\CacheAdapter($storage, 'namespace');
+
+// Nastavíme platnost cachovaných dat
+$cache->setExpiration('1 day');
+
+// Vytvoříme cachovanou webovou službu
+$cachedWebService = new CacheDecorator($webService, $cache);
+
+// Nyní můžeme použít cachovanou webovou službu jako klasickou webovou službu
+$cachedWebService->call('UserDetail', ['ID' => 1940]);
+```

docs/konfigurace.md

@@ -0,0 +1,24 @@
+# Konfigurace rozšíření
+
+## Testovací režim
+
+Volba `testMode: TRUE` přepne knihovnu do testovacího režimu a všechny požadavky budou prováděny proti http://test-is.skaut.cz/ namísto ostré verze SkautISu.
+
+
+## Cachování WSDL souboru
+
+Pomocí volby `cache: FALSE` je možné vypnout cachování WSDL souboru. Pokud k tomu nemáte závažný důvod doporučujeme cachování ponechat zapnuté.
+
+
+## Komprese požadavků
+
+Pomocí volby `compression: FALSE` je možné vypnout kompresi při provádění požadavků na SkautIS. Pokud k tomu nemáte závažný důvod doporučujeme kompresi ponechat zapnutou.
+
+
+## Profiler
+
+Pokud máte nainstalovánou [Tracy](https://github.com/nette/tracy), nebo používáte Nette verze 2.1, tak se v testovacím modu Nette automaticky aktivuje skautis panel, který sleduje všechny dotazy na skautis.
+
+![Skautis panel pro ladění aplikace](skautis-panel.png)
+
+Panel je možné úplně vypnout pomocí volby `profiler: FALSE`.