src/site/ru/apt/index.apt.vm

   1  ------
   2  Введение
   3  ------
   4  Dmitry Samoshin aka gotty
   5  ------
   6  2017-01-22
   7  ------
   8
   9 ~~ Copyright (c) 2017. Developed by Hedgecode.
  10 ~~
  11 ~~ Licensed under the Apache License, Version 2.0 (the "License");
  12 ~~ you may not use this file except in compliance with the License.
  13 ~~ You may obtain a copy of the License at
  14 ~~
  15 ~~   http://www.apache.org/licenses/LICENSE-2.0
  16 ~~
  17 ~~ Unless required by applicable law or agreed to in writing, software
  18 ~~ distributed under the License is distributed on an "AS IS" BASIS,
  19 ~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  20 ~~ See the License for the specific language governing permissions and
  21 ~~ limitations under the License.
  22
  23 ~~ NOTE: For help with the syntax of this file, see:
  24 ~~ http://maven.apache.org/doxia/references/apt-format.html
  25
  26 ${project.name}
  27
  28   Hedgecode Snooker Score представляет собой библиотеку с набором API сущностей, которая
  29   может использоваться в клиентских Java-приложениях, имеющих своей целью информирование
  30   о результатах снукерных матчей, а также о прочей статистической информации из мира снукера.
  31
  32   Вся полезная информация загружается по протоколу HTTP с портала {{{http://snooker.org/}snooker.org}},
  33   поэтому для функционирования приложений, использующих данную библиотеку, необходим доступ в Интернет.
  34
  35   Текущая версия библиотеки:
  36   {{{http://repo.hedgecode.org/content/repositories/releases/org/hedgecode/snooker/${project.artifactId}/${project.version}/${project.artifactId}-${project.version}.jar}${project.version}}}
  37
  38   <<Примечание>>: <Все версии библиотеки до версии 1.0 не могут считаться полностью стабильными.>
  39
  40 * Использование
  41
  42   Общие инструкции о том, как использовать данную библиотеку можно найти на {{{./usage.html}этой странице}}.
  43
  44   Описание работы основных методов библиотеки находится в разделе {{{./faq.html}ЧаВо}}.
  45
  46   Некоторые более конкретные случаи использования описаны в примерах, приведенных ниже.
  47
  48 * Примеры
  49
  50   Чтобы лучше понять описываемую библиотеку, вы можете обратиться к следующим примерам:
  51
  52   * {{{./examples/work-with-the-cached-api.html}Работа с кэширующей версией API}}
  53
  54   * {{{./examples/use-sort-in-collections.html}Использование сортировки полученных данных}}
  55
  56   * {{{./examples/handle-the-api-exceptions.html}Обработка исключений, возникающих при работе с API}}
  57
  58   []