------
 Введение
 ------
 Dmitry Samoshin aka gotty
 ------
 2017-01-22
 ------

~~ Copyright (c) 2017. Developed by Hedgecode.
~~
~~ Licensed under the Apache License, Version 2.0 (the "License");
~~ you may not use this file except in compliance with the License.
~~ You may obtain a copy of the License at
~~
~~   http://www.apache.org/licenses/LICENSE-2.0
~~
~~ Unless required by applicable law or agreed to in writing, software
~~ distributed under the License is distributed on an "AS IS" BASIS,
~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~~ See the License for the specific language governing permissions and
~~ limitations under the License.

~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html

${project.name}

  Hedgecode Snooker Score представляет собой библиотеку с набором API сущностей, которая
  может использоваться в клиентских Java-приложениях, имеющих своей целью информирование
  о результатах снукерных матчей, а также о прочей статистической информации из мира снукера.

  Вся полезная информация загружается по протоколу HTTP с портала {{{http://snooker.org/}snooker.org}},
  поэтому для функционирования приложений, использующих данную библиотеку, необходим доступ в Интернет.

  Текущая версия библиотеки:
  {{{http://repo.hedgecode.org/content/repositories/releases/org/hedgecode/snooker/${project.artifactId}/${project.version}/${project.artifactId}-${project.version}.jar}${project.version}}}

  <<Примечание>>: <Все версии библиотеки до версии 1.0 не могут считаться полностью стабильными.>

* Использование

  Общие инструкции о том, как использовать данную библиотеку можно найти на {{{./usage.html}этой странице}}.

  Описание работы основных методов библиотеки находится в разделе {{{./faq.html}ЧаВо}}.

  Некоторые более конкретные случаи использования описаны в примерах, приведенных ниже.

* Примеры

  Чтобы лучше понять описываемую библиотеку, вы можете обратиться к следующим примерам:

  * {{{./examples/work-with-the-cached-api.html}Работа с кэширующей версией API}}

  * {{{./examples/use-sort-in-collections.html}Использование сортировки полученных данных}}

  * {{{./examples/handle-the-api-exceptions.html}Обработка исключений, возникающих при работе с API}}

  []