Update README.md

- add docs/clients.md
This commit is contained in:
Luna 2019-03-26 00:44:05 -03:00
parent 15fa2f3231
commit 4c4efb61da
2 changed files with 38 additions and 5 deletions

View File

@ -31,10 +31,11 @@ took a shot at writing it again. It works.
## Caveats ## Caveats
- Unit testing is incomplete. - Unit testing is incomplete.
- Currently, there are no plans to support video in voice chats, or the Discord Store. - Currently, there are no plans to support video in voice chats, or the
- You must figure out how to connect to a Litecord instance. Litecord will not Discord Store.
distribute official client code from Discord nor provide ways to modify the - An unofficial Discord Client is recommended to connect (more on
official client. `docs/clients.md`). Litecord will not distribute official client code from
Discord nor provide ways to modify the official client.
## Implementation status, AKA "Does it work?" ## Implementation status, AKA "Does it work?"
@ -54,7 +55,7 @@ time.
We (Litecord and contributors) are not liable for usage of this software, We (Litecord and contributors) are not liable for usage of this software,
valid or invalid. If you intend to use this software as a "self-hostable valid or invalid. If you intend to use this software as a "self-hostable
Discord alternative", you are soely responsible for any legal action delivered Discord alternative", you are solely responsible for any legal action delivered
by Discord if you are using their assets, intellectual property, etc. by Discord if you are using their assets, intellectual property, etc.
All referenced material for implementation is based off of All referenced material for implementation is based off of

32
docs/clients.md Normal file
View File

@ -0,0 +1,32 @@
# Clients that can work with Litecord
- discord-term (https://github.com/cloudrex/discord-term), with manual edits
```diff
diff --git a/src/display.ts b/src/display.ts
index e844553..9e8521a 100644
--- a/src/display.ts
+++ b/src/display.ts
@@ -205,7 +205,15 @@ export default class Display {
...state
};
- this.client = new Client;
+ this.client = new Client({
+ http: {
+ host: 'https://INSTANCE_URL_HERE',
+ cdn: 'https://INSTANCE_URL_HERE',
+ version: 6
+ },
+ fetchAllMembers: true,
+ sync: true
+ });
this.commands = commands;
}
```
## Clients known to not work with litecord
Clients built on libraries that do not have an easy way to edit the base URL are
not suited for Litecord.
- crcophony (https://github.com/freyamade/crcophony), discord.cr