Merge pull request #11 from claromes/beach

Class Beach

.gitignore

@@ -1,12 +1,8 @@
+# cache
+fivbvis/__pycache__
+
 # test
-.pytest_cache/
-fivbvis/__pycache__/
-tests/__pycache__/
-tests/vcr_cassettes/
-tests/tests/
-tests/.coverage
-example.py
-request.txt
+examples.py
 
 # build
 /dist/

README.md

@@ -1,14 +1,12 @@
 # FIVB VIS Python Client
 
-[![PyPI](https://img.shields.io/pypi/v/fivbvis)](https://pypi.org/project/fivbvis/)
+[![PyPI](https://img.shields.io/pypi/v/fivbvis)](https://pypi.org/project/fivbvis/) ![Development Status :: 4 - Beta](https://img.shields.io/badge/development_status-4_--_Beta-yellow) [![PyPI](https://img.shields.io/pypi/dm/fivbvis.svg)](https://pypistats.org/packages/fivbvis)
 
-Python client library for easy integration with [FIVB VIS Web Service](https://www.fivb.org/VisSDK/VisWebService/#Introduction.html) public data, providing XML and JSON responses.
+The package `fivbvis` is a Python client library for easy integration with the [Volleyball Information System Web Service](https://www.fivb.org/VisSDK/VisWebService) of the Fédération Internationale de Volleyball (FIVB), handling public data and only documented requests, and providing XML and JSON responses.
 
-**This client is not affiliated with the Fédération Internationale de Volleyball (FIVB).**
+The VIS Web Service enables third party applications to access all public data about volleyball, beach volleyball and other events. This client facilitates access for Python programmers, enabling access to data such as articles, matches, events, images, players, player rankings, and tournaments.
 
-## Requirements
-
-- Python 3.8+
+It is compatible with Python versions 3.8 and above, but it has been tested specifically on versions 3.8 and 3.11.
 
 ## Installation
 
@@ -20,40 +18,30 @@ pip install fivbvis
 Basic example:
 
 ```python
-from fivbvis import VolleyMatch
+from fivbvis import Volleyball
 
-vm = VolleyMatch()
-print(vm.getMatch(9211, response_format="json"))
+v = Volleyball()
+v.getVolleyMatch(9211, fields="City CountryName DateLocal TeamNameA TeamNameB")
 ```
-JSON return:
-
-```json
-{
-   "data":{
-      "assistantScorerCountryCode":"None",
-      "assistantScorerFirstName":"None",
-      "assistantScorerLastName":"None",
-      "beginDateTimeUtc":"2018-10-07T04:25:00Z",
-      "buyTicketsUrl":"",
-      "city":"Nagoya",
-      "countryCode":"JP",
-      ...
-   }
-}
+XML response:
+
+```xml
+<VolleyballMatch
+   City="Nagoya"
+   CountryName="Japan"
+   DateLocal="2018-10-07"
+   TeamNameA="Germany"
+   TeamNameB="Brazil"
+   No="9211"
+   Version="2393792"/>
 ```
-## Documentation
-
-[Web Service Requests Reference](docs/reference.md)
 
-## Development
-
-$ `git clone git@github.com:claromes/fivbvis.git`
+## Documentation
 
-$ `cd fivbvis`
+The documentation is based on FIVB VIS Web Service requests. It is simple and includes only requests documented by the FIVB developer team. Check the [docs folder](https://github.com/claromes/fivbvis/blob/main/docs/documentation.md) for detailed information and examples.
 
-$ `pip install -r requirements.txt`
+[This list contains all available requests via VIS web service](https://www.fivb.org/VisSDK/VisWebService/#RequestList.html); those with links are documented. Currently, this Python client is read-only.
 
-$ `pip install --editable .`
 
 ## Author