aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorveradec <glitchmill.dyj3d@simplelogin.co>2026-11-12 11:30:13 +0530
committerveradec <glitchmill.dyj3d@simplelogin.co>2026-11-12 11:30:13 +0530
commit8c7f9f17eb07b1debcffffbf5283beda6aabfeea (patch)
treec4cc4db7bff597e3ea2cca9762f029f78c7c091b
parent19e897195e0faf894a6fce491c6667e8159153dc (diff)
add: sections to README
-rw-r--r--README.md66
1 files changed, 65 insertions, 1 deletions
diff --git a/README.md b/README.md
index a9359f0..d5f835f 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,67 @@
+
# UxU
-UxU is a file hosting service
+UxU is a file hosting service, an alternative to [0x0.st](https://0x0.st) (which i am pretty sure isnt working) is written in Go.
+## Run Locally
+
+Clone the project
+
+```bash
+ git clone https://git.veradec.xyz/UxU.git
+```
+
+Go to the project directory
+
+```bash
+ cd UxU
+```
+
+Install dependencies
+
+```bash
+ go install
+```
+
+Start the server
+
+```bash
+ go run . --domain=https://yourdomain.xyz
+```
+
+
+## Demo
+
+Insert gif or link to demo
+
+
+## Acknowledgements
+
+ - [0x0.st](https://0x0.st)
+ - [Gin Documentation](https://gin-gonic.com/en/docs/)
+
+
+## FAQ
+
+#### There is no Upload Button, How do I actually Upload?
+
+Using the curl command
+```curl -X POST https://uxu.veradec.xyz -F "file=@file.png"```
+
+#### How do I Fetch the Files then?
+
+the reponse will be a link with your Filename
+
+https://uxu.veradec.xyz/{random_string}/file.png
+
+and you can use the link to view the file
+
+## Feedback
+
+If you have any feedback, please reach out to us at veradec@duck.com
+
+
+## Contributing
+
+Contributions are always welcome!
+
+Mail me the git diffs - verade@duck.com