Publish Metadata Files

README.md

@@ -0,0 +1,96 @@
+# Libreddit
+
+> An alternative private front-end to Reddit 
+
+Libre + Reddit = Libreddit
+
+- 🚀 Fast: written in Rust for blazing fast speeds and safety
+- ☁️ Light: no javascript, no ads, no tracking
+- 🕵 Private: ~~all~~ most requests are proxied through the server (images are still loaded from Reddit)
+- 🔒 Safe: does not rely on Reddit's closed APIs 
+- 📱 Responsive: works great on mobile!
+
+Think Invidious but for Reddit. Watch your cat videos without being watched.
+
+## Screenshot
+
+![](https://i.ibb.co/SfFHDhh/image.png)
+
+## Status
+
+- [x] Hosting
+  - [x] Instances
+    - [x] Clearnet instance
+    - [ ] .onion instance
+  - [x] Cargo deployment
+  - [x] Docker deployment
+- [x] Subreddits
+  - [x] Title
+  - [x] Description
+  - [x] Posts
+    - [x] Post sorting
+- [x] Posts
+  - [x] Comments
+    - [x] Comment sorting
+    - [ ] Nested comments
+  - [x] UTC post date
+  - [x] Image thumbnails
+  - [x] Embedded images
+    - [ ] Proxied images 
+  - [x] Reddit-hosted video
+    - [ ] Proxied video
+  - [ ] Localized post date
+- [x] Users
+  - [x] Username
+  - [x] Karma
+  - [x] Description
+  - [x] Post history
+    - [x] Post sorting
+  - [ ] Comment history
+    - [ ] Comment sorting
+
+- [ ] Search
+  - [ ] Post aggregating
+  - [ ] Comment aggregating
+  - [ ] Result sorting
+
+## Instances
+
+- [libredd.it](https://libredd.it) 🇺🇸 (Thank you to [YeapGuy](https://github.com/YeapGuy)!)
+- [libreddit.spike.codes](https://libreddit.spike.codes) 🇺🇸
+
+## Deploy an Instance
+
+### A) Manual
+
+Make sure Rust stable is installed along with `cargo`, Rust's package manager.
+
+```
+cargo install --git https://github.com/spikecodes/libreddit
+```
+
+### B) Docker
+
+Deploy the Docker image of Libreddit:
+```
+docker run -d --name libreddit -p 8000:8000 spikecodes/libreddit
+```
+
+Deploy using a different port (in this case, port 80):
+```
+docker run -d --name libreddit -p 80:8000 spikecodes/libreddit
+```
+
+### C) AUR
+
+Libreddit is available from the Arch User Repository as [`libreddit-git`](https://aur.archlinux.org/packages/libreddit-git).
+
+Install:
+```
+yay -S libreddit-git
+```
+
+Deploy:
+```
+libreddit
+```