https://github.com/hostari/thunderstore_client
A crystal lang wrapper over the Thunderstore API
https://github.com/hostari/thunderstore_client
crystal thunderstore
Last synced: about 2 months ago
JSON representation
A crystal lang wrapper over the Thunderstore API
- Host: GitHub
- URL: https://github.com/hostari/thunderstore_client
- Owner: hostari
- License: mit
- Created: 2022-04-23T00:08:09.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-12T16:40:16.000Z (about 1 year ago)
- Last Synced: 2024-02-13T16:15:54.932Z (about 1 year ago)
- Topics: crystal, thunderstore
- Language: Crystal
- Homepage: https://hostari.github.io/thunderstore_client/
- Size: 27.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# thunderstore_client
The Thunderstore API Crystal wrapper. Fetch game modification info from your
Crystal code.
Copyright 2022-2024 Hostari Philippines, Inc. See LICENSE for copying information.
📝 Implements: [REST API Reference (V1)](https://valheim.thunderstore.io/api/docs/)
😘 Maintainer(s): @xaviablaza
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
thunderstore_client:
github: hostari/thunderstore_client
```
2. Run `shards install`
## Usage
```crystal
require "thunderstore_client"
```
Build a new Thunderstore client with the `community` that you want to target.
```crystal
client = Thunderstore::Client.new
client.set_community("valheim")
```
Then, your client is ready to be consumed!
## Resource Methods
Most useful available Thunderstore API resources are implemented.
### Package
- **v1_package_list**
- **List Packages**
- `Thunderstore::Package.list(client : Thunderstore::Client) : Array(Thunderstore::Package)`
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [Xavi Ablaza](https://github.com/xaviablaza) - creator and maintainer