diff --git a/README.md b/README.md new file mode 100644 index 0000000..4fc0d55 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +### Commsy REST API +Provides a REST API to commsy servers via libcommsy + +## Example server +`https://apis.home.tuxifan.cf/commsy/` + +Endpoints: + +# `fetchList` +GET parameters: + * url: URL to the commsy server (start page) + * sid: SID to authenticate with + * room: room to load + * startId: ID before the first ID to list (optional, default: start with first post) + * maxPosts: maximum amount of posts to load \ No newline at end of file