[LIB-8] Release snooker-score-api-0.2
[snooker-score-api.git] / README.md
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..131180d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+## Hedgecode Snooker Score API
+
+### Description
+
+Hedgecode Snooker Score is an API library for portal [snooker.org](http://www.snooker.org/),
+which contains the results of snooker competitions and other snooker information.
+The library provides a set of entity objects that can be used in client
+applications (to inform about the results of snooker) developed in Java.
+
+### Links
+
+Below are links to the library description pages:
+- [ENG](https://lib.hedgecode.org/snooker-score-api/)
+- [RUS](https://lib.hedgecode.org/snooker-score-api/ru/)
+
+You can also refer to the following information:
+[Usage](https://lib.hedgecode.org/snooker-score-api/usage.html),
+[FAQ](https://lib.hedgecode.org/snooker-score-api/faq.html),
+[Download](https://lib.hedgecode.org/snooker-score-api/download.html).
+
+Copyright © 2017-2020 [Hedgecode](https://hedgecode.org/).