diff --git a/README.md b/README.md new file mode 100644 index 0000000..eb52f93 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +### Commsy REST API +Provides a REST API to commsy servers via libcommsy + +## Example server +`https://commsyapi.home.tuxifan.cf` + +Endpoints: + +# `/fetchList` +GET parameters: + * url: URL to the commsy server (startpage) + * 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 diff --git a/README.txt b/README.txt deleted file mode 100644 index 7ffdc80..0000000 --- a/README.txt +++ /dev/null @@ -1 +0,0 @@ -https://commsyapi.home.tuxifan.cf/fetchList?url=&sid=&room=&startId=[ID before the first ID to list]&maxPosts=[maximum amount of posts to load] \ No newline at end of file