Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fekie committed Mar 16, 2023
1 parent 23588a9 commit b148796
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
# roli

A low level api wrapper for the Rolimons.com.
A low level api wrapper for Rolimons.com.

# Notes

* This crate is a low level wrapper due to the fact that allowed requests to the API are limited. To maintain flexibiliy while also using the API endpoints responsibly, the user is expected to maintain their own caching.

* This library is currently *unstable* until the release of v1.0.0, APIs may be subject to change across minor releases without warning.
* This library is currently *unstable* while under version v0.0.x, APIs may be subject to change across minor releases without warning.

# API Coverage Checklist
- [x] Items API
- [x] Deals API
- [ ] Trade Ad API

(more to be added, issues for API coverage requests welcome)

# Contributing
There is still a lot of work to be done! Pull requests are welcome!
Pull requests are welcome!

Note that all public non-util functions are required to make exactly one API call.

Expand Down

0 comments on commit b148796

Please sign in to comment.