diff --git a/README.md b/README.md index d3f3f6d..4713f49 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ + # ChatterUI -Simple frontend for LLMs built in react-native. + +Simple frontend for LLMs built using react-native. +### What is it? +A frontend for managing chat files and character cards similar to projects like TavernAI / SillyTavern. +Built for the purpose of learning Javascript, so it may be a little rough around the edges. + +### Supported Backends +- KoboldAI + +### Building from source. +Building from source has **not** been tested. +Requires Node.js and Android SDK. Expo uses EAS to build apps which in a Linux environment. Release APKs are built in WSL. +``` +npm install +eas build --platform android --local +```