From 081dcb887be0fe3e15b28ded0543145f3627a55f Mon Sep 17 00:00:00 2001
From: hernik <matasaurus@seznam.cz>
Date: Thu, 2 Jun 2022 13:24:53 +0000
Subject: [PATCH] GitBook: [#2] No subject

---
 README.md                 | 19 +++++++++++++++++
 SUMMARY.md                |  9 ++++++++
 quick-start.md            | 44 +++++++++++++++++++++++++++++++++++++++
 reference/prehled-trid.md |  4 ++++
 reference/priklady.md     |  2 ++
 5 files changed, 78 insertions(+)
 create mode 100644 README.md
 create mode 100644 SUMMARY.md
 create mode 100644 quick-start.md
 create mode 100644 reference/prehled-trid.md
 create mode 100644 reference/priklady.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..59db8e5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# Vítejte!
+
+Toto je oficiální, člověkem čitelná, dokumentace pro Dart knihovnu [canteenlib](https://pub.dev/packages/canteenlib)
+
+## Jdeme na to?
+
+Quick start vám ukáže, jak rychle začít používat tuto knihovnu
+
+{% content-ref url="quick-start.md" %}
+[quick-start.md](quick-start.md)
+{% endcontent-ref %}
+
+## Má to hlubší význam?
+
+Většina tříd a metod je popsána v referenci k API.
+
+{% content-ref url="reference/prehled-trid.md" %}
+[prehled-trid.md](reference/prehled-trid.md)
+{% endcontent-ref %}
diff --git a/SUMMARY.md b/SUMMARY.md
new file mode 100644
index 0000000..8aebaad
--- /dev/null
+++ b/SUMMARY.md
@@ -0,0 +1,9 @@
+# Table of contents
+
+* [Vítejte!](README.md)
+* [Quick Start](quick-start.md)
+
+## Reference
+
+* [Příklady](reference/priklady.md)
+* [Přehled tříd](reference/prehled-trid.md)
diff --git a/quick-start.md b/quick-start.md
new file mode 100644
index 0000000..f8d5b80
--- /dev/null
+++ b/quick-start.md
@@ -0,0 +1,44 @@
+---
+description: Jak začít s používáním API
+---
+
+# Quick Start
+
+{% hint style="danger" %}
+Využívání balíku je na vlastní nebezpečí, neručíme za škody způsobené používáním!
+{% endhint %}
+
+## Instalace balíku
+
+Knihovna je hostována na [pub.dev](https://pub.dev/packages/canteenlib), instalace se provede jednoduše pomocí `dart pub add canteenlib`, pokud používáte Flutter pak `flutter pub add canteenlib`
+
+## Vytvořit instanci
+
+Základem je vytvoření instance třídy `Canteen`, která obsahuje všechny metody pro komunikaci s iCanteen. Jediný parametr této třídy je URL k vašemu kýženému iCanteen.
+
+```dart
+import 'package:canteenlib/canteenlib.dart';
+// ...
+Canteen c = Canteen("https://kantyna.neco.cz");
+// ...
+```
+
+## Přihlášení
+
+Přihlášení za váš účet provedete pomocí metody `login`, parametry jsou uživatelské jméno a heslo.
+
+{% hint style="info" %}
+Knihovna používá hlavně [asynchronní funkce](https://dart.dev/codelabs/async-await), které vrací Future, doporučujeme používat uvnitř jiné asynchronní funkce s `await`.
+{% endhint %}
+
+```dart
+// ...
+Canteen c = Canteen("https://kantyna.neco.cz");
+var l = await c.login("jmeno","heslo")
+```
+
+Metoda vrací `bool` nebo chybu. Pokud se nelze přihlásit pomocí jména nebo hesla, vrací metoda `false`, v případě jiné chyby `Future.error` a při úspěšném přihlášení `true`.
+
+## Dělejte co potřebujete
+
+Nyní byste měli být připravení na to, abyste posílali ostatní požadavky. Prohlédněte si [referenci](broken-reference), [podrobnou dokumentaci](https://pub.dev/documentation/canteenlib/latest/canteenlib/canteenlib-library.html) nebo [příklady](reference/priklady.md) pro pomoc s pokračováním.
diff --git a/reference/prehled-trid.md b/reference/prehled-trid.md
new file mode 100644
index 0000000..31b0557
--- /dev/null
+++ b/reference/prehled-trid.md
@@ -0,0 +1,4 @@
+# Přehled tříd
+
+Zde jsou zdokumentované všechny třídy, které lze uvnitř knihovny najít.
+
diff --git a/reference/priklady.md b/reference/priklady.md
new file mode 100644
index 0000000..d23ecdc
--- /dev/null
+++ b/reference/priklady.md
@@ -0,0 +1,2 @@
+# Příklady
+