src/site/apt/index.apt.vm

   1  ------
   2  Introduction
   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   ${project.description}
  29
  30   All useful information is downloaded via the HTTP protocol from the portal {{{http://snooker.org/}snooker.org}},
  31   so for the functioning of applications that use this library Internet access is required.
  32
  33   The current version of the library:
  34   {{{http://repo.hedgecode.org/content/repositories/releases/org/hedgecode/snooker/${project.artifactId}/${project.version}/${project.artifactId}-${project.version}.jar}${project.version}}}
  35
  36   <<Note>>: <All versions of the library up to version 1.0 can not be considered completely stable.>
  37
  38 * Usage
  39
  40   General instructions on how to use this library can be found on the {{{./usage.html}usage page}}.
  41
  42   Description of the main methods of the library is in the section {{{./faq.html}FAQ}}.
  43
  44   Some more specific use cases are described in the examples given below.
  45
  46 * Examples
  47
  48   To better understand the described library you can refer to the following examples:
  49
  50   * {{{./examples/work-with-the-cached-api.html}Working with the cached version API}}
  51
  52   * {{{./examples/use-sort-in-collections.html}Using sorting of received data}}
  53
  54   * {{{./examples/handle-the-api-exceptions.html}Handling the API exceptions}}
  55
  56   []