------
 Introduction
 ------
 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}

  ${project.description}

  All useful information is downloaded via the HTTP protocol from the portal {{{http://snooker.org/}snooker.org}},
  so for the functioning of applications that use this library Internet access is required.

  The current version of the library:
  {{{http://repo.hedgecode.org/content/repositories/releases/org/hedgecode/snooker/${project.artifactId}/${project.version}/${project.artifactId}-${project.version}.jar}${project.version}}}

  <<Note>>: <All versions of the library up to version 1.0 can not be considered completely stable.>

* Usage

  General instructions on how to use this library can be found on the {{{./usage.html}usage page}}.

  Description of the main methods of the library is in the section {{{./faq.html}FAQ}}.

  Some more specific use cases are described in the examples given below.

* Examples

  To better understand the described library you can refer to the following examples:

  * {{{./examples/work-with-the-cached-api.html}Working with the cached version API}}

  * {{{./examples/use-sort-in-collections.html}Using sorting of received data}}

  * {{{./examples/handle-the-api-exceptions.html}Handling the API exceptions}}

  []