Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
airblast-dev committed Mar 12, 2024
1 parent c00188a commit 4faed66
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,8 @@ Almost all functionality of the API is implemented and with (mostly) proper exce

> **_NOTE:_** This is an unofficial library for the vShield API. There-for vShield is not responsible for any issues regarding this library.
> **_WARNING_** The library is in its early stages this means breaking changes are made very often. Beware!
<a href="https://vshield.pro"><img src="https://cdn.discordapp.com/attachments/1048581891411951636/1170771111361917008/bannerblue.png?ex=655a4090&is=6547cb90&hm=a0579448a362ca4b2c9dc8014ed765d0c7579ecd19043c6a24dd65e6981edbcf&"></a>

In case of any issues using the library, be it better exception handling or ease of use ... feel free to create an issue on Github.

### Supported Products:

All products do have support, however virtual servers (VPS, VDS and VDS-PRO)
Expand All @@ -35,3 +31,11 @@ Example for creating a client and sending a request to check the accounts curren
```

> **_NOTE:_** For an implementation example in an application such as a discord bot, feel free to check out the [examples](examples/README.md).
### Contribution:
The library does cover all API paths, however, there are a few small things missing.
- Setting a wallpaper for a server. (This is only doable if you have reseller access)
- Tasks are not stored in the instance of a server, said tasks are only returned by `/server/getInfo/<server_id>`.
- The ease of use of the library might be lacking for various use cases such as hosting a reseller website.

For non-breaking and/or small changes feel free to create a PR. If not create an issue so a solution can be discussed.

0 comments on commit 4faed66

Please sign in to comment.