From 939223bfe9d37a3e93e1f40f63961fb0a77ebccf Mon Sep 17 00:00:00 2001
From: Seb3thehacker <88462253+Seb3thehacker@users.noreply.github.com>
Date: Wed, 23 Mar 2022 23:38:37 +0000
Subject: [PATCH] Update README.md
---
README.md | 38 +++++++++++++++++++++++++-------------
1 file changed, 25 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
index 7588184..7141edb 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,19 @@
linx-server
======
-Self-hosted file/media sharing website.
+A self-hosted file/media sharing website. Its primary use is for temporay file sharing and pastebin-like text sharing.
+
+
+### Features
+
+- Display common filetypes (image, video, audio, markdown, pdf)
+- Display syntax-highlighted code with in-place editing
+- Documented API with keys for restricting uploads
+- Torrent download of files using web seeding
+- File expiry, deletion key, file access key, and random filename options
+- File previews are now supported for sites like Twitter and Discord
+- Files are locked when uploading to prevent tampering
+
### Clients
**Official**
@@ -12,16 +24,7 @@ Self-hosted file/media sharing website.
- CLI: **golinx** - [Source](https://github.com/mutantmonkey/golinx)
-### Features
-
-- Display common filetypes (image, video, audio, markdown, pdf)
-- Display syntax-highlighted code with in-place editing
-- Documented API with keys for restricting uploads
-- Torrent download of files using web seeding
-- File expiry, deletion key, file access key, and random filename options
-
-
-### Screenshots
+### Screenshots - OUT OF DATE
@@ -58,9 +61,18 @@ services:
- "8080:8080"
restart: unless-stopped
```
-Ideally, you would use a reverse proxy such as nginx or caddy to handle TLS certificates.
+Ideally, you would use a reverse proxy such as nginx or caddy to handle TLS certificates.
-#### Using a binary release
+#### Manual build
+```
+go build
+```
+To run
+```
+./linx-server -config config
+```
+
+#### Using a binary release - NOT SUPPORTED CURRENTLY
1. Grab the latest binary from the [releases](https://github.com/andreimarcu/linx-server/releases), then run ```go install```
2. Run ```linx-server -config path/to/linx-server.conf```