aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJames Barnett <noreply@jamesbarnett.xyz>2020-04-10 13:34:23 +0100
committerJames Barnett <noreply@jamesbarnett.xyz>2020-04-10 13:34:23 +0100
commit78400d587ea5367d3424333913ff4f94ca3f1908 (patch)
tree2cf5f5ff8069740b0b7dd00853a4ea8c13d6e05c /README.md
parentd5a608143ad2250d8b35b9e4a488d39faaf5a021 (diff)
downloadreddit-lite-78400d587ea5367d3424333913ff4f94ca3f1908.tar.xz
reddit-lite-78400d587ea5367d3424333913ff4f94ca3f1908.zip
Reimplement in Kotlin
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 27 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1db4eba..daba22a 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,27 @@
-# reddit-lite \ No newline at end of file
+# reddit-lite
+Demo [here](https://reddit.james-barnett.net)
+
+A lightweight, minimal, readonly Reddit client, designed for mobile devices or slow connections.
+![comments](https://james-barnett.net/files/reddit-lite/screenshots/rl3.png)
+
+## Running locally
+Reddit-lite is written in [play](https://www.playframework.com/).
+Running a non distribution version requires [sbt](http://www.scala-sbt.org/index.html) (which sucks btw).
+
+```sh
+git clone https://github.com/jamesbarnett91/reddit-lite && cd reddit-lite
+mv conf/application.conf.sample conf/application.conf
+sbt run
+```
+Alternatively, just use IntelliJ with the scala plugin and import the project.
+
+## TODOs
+* ~~option to hide thumbnails~~ [done]
+* ~~collapsible comments~~ [done]
+* async load of deeply nested comments
+* sort posts/comments by top/hot/new
+* view subreddit info/sidebar
+* highlight gilded posts/comments
+* highlight comments from OP
+* clean up css and maybe inline it to save an http request
+* should probably write some tests...