Skip to content

Commit

Permalink
Updated real usage, added API Docs to top.
Browse files Browse the repository at this point in the history
  • Loading branch information
MujyKun authored May 21, 2021
1 parent 52ec050 commit ef9fbe3
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
## Weverse

### What is it?
Weverse creates internal cache for the communities a user follows on [weverse.io](https://www.weverse.io/).
Weverse creates internal cache for the communities a user follows on [weverse.io](https://www.weverse.io/).

### **[API Documentation](https://weverse.readthedocs.io/en/latest/)**

### Functionalities

* Asynchronous and Synchronous Support
* Receive all the posts the artists in your communities have made. This includes all images/videos/comments made by them.
* Cache is split under a hierarchy directly under a community. The most recent is always the first element (0th index).
* Keep track of notifications on your user account, you can easily create a loop to update your notification cache on updates. [**Example of real usage**](https://github.com/MujyKun/IreneBot/blob/9193fcd3b6c73f61c57fb2fad557921141b1c07a/module/Weverse.py#L65)
* Keep track of notifications on your user account, you can easily create a loop to update your notification cache on updates. [**Example of real usage**](https://github.com/MujyKun/IreneBot/blob/5ed92595314e146d0f4a7a3f04461afd168d327f/module/Weverse.py#L80)

### Installation

Expand Down Expand Up @@ -71,4 +73,4 @@ except InvalidToken:

```

## **[API Documentation](https://weverse.readthedocs.io/en/latest/)**
### **[API Documentation](https://weverse.readthedocs.io/en/latest/)**

0 comments on commit ef9fbe3

Please sign in to comment.