From 8e5ec42b5c14c625c1fcb7b8e57db836a9520660 Mon Sep 17 00:00:00 2001
From: stringsplit <77242831+nbitzz@users.noreply.github.com>
Date: Fri, 17 Mar 2023 14:10:33 -0700
Subject: [PATCH] readme lift

---
 README.md | 57 +++++++++++++++++++++++++++++++++----------------------
 1 file changed, 34 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index 1198e01..a707d8c 100644
--- a/README.md
+++ b/README.md
@@ -1,33 +1,44 @@
 # monofile
-File sharing via Discord
- 
+The open-source, Discord-based file sharing service.
+[Live instance](https://fyle.uk)
+
 <br>
 
-## .env
+## Setup
 
+First, install monofile's prerequisites...
 ```
-TOKEN=KILL-YOURSELF.NOW
+npm i
 ```
 
-## versions & planned updates
+Then, add your bot token...
+```
+echo "TOKEN=INSERT-TOKEN.HERE" > .env
+```
 
-- [X] 1.0.0 initial release
-- [X] 1.1.0 add file cloning endpoint
-- [X] 1.1.1 add file cloning webpage
-- [X] 1.1.2 fix file cloning with binary data
-- [X] 1.1.3 display current version on pages
-- [X] 1.1.4 serve /assets as static files & make /server endpoint
-- [X] 1.2.0 add file parameters section + custom ids
-- [X] 1.2.1 add file counter to main page
-- [X] 1.2.2 clean up this shitty code
-- [X] 1.2.3 bugfixes
-- [ ] 1.3.0 new ui; collections; accounts; utility endpoints; multi file uploads
-- [ ] 1.3.1 self-destructing files
-- [ ] 1.3.2 disable cloning of local ips
-- [ ] 1.4.0 admin panel
-- [ ] 2.0.0 rewrite using theUnfunny's code as a base/rewrite using monofile-core
+Invite your bot to a server, then give it a channel to post in:
+```json
+config.json
+--------------------------------------------
+...
+    "targetGuild": "1024080490677936248",
+    "targetChannel": "1024080525993971913",
+...
+```
 
-also todo: monofile-core (written in eris)
+Then, compile and start.
+```
+tsc && npm start
+```
 
-## Disclaimer!
-This project does some stuff that can be considered questionable. Discord may not like you uploading files this way, and it's a grey area in Discord's TOS. We take no responsibility if Discord locks your account for API abuse. 
\ No newline at end of file
+monofile should now be running on either `env.MONOFILE_PORT` or port `3000`.
+
+## Disclaimer
+
+Although we believe monofile is not against Discord's developer terms of service, monofile's contributors are not liable if Discord takes action against you for running an instance.
+
+## License
+
+Code written by monofile's contributors is currently licensed under [Unlicense](https://github.com/nbitzz/monofile/blob/main/LICENSE).
+
+Icons under `/assets/icons` were created by Microsoft, and as such are licensed under [different terms](https://github.com/nbitzz/monofile/blob/1.3.0/assets/icons/README.md).
\ No newline at end of file