From 4bff67215703158e833d2e29cfca4029efb1bf83 Mon Sep 17 00:00:00 2001
From: Jesper Wrang
Date: Thu, 5 Dec 2019 10:11:18 +0100
Subject: [PATCH] Update README
---
README.md | 13 ++-----------
src/pages/about/index.js | 12 ++++++------
src/pages/common/Header.js | 6 +++---
3 files changed, 11 insertions(+), 20 deletions(-)
diff --git a/README.md b/README.md
index 4b161c6..95a139c 100644
--- a/README.md
+++ b/README.md
@@ -2,30 +2,21 @@
[Removeddit](https://removeddit.com) is a site for viewing removed comments / threads from [Reddit](https://www.reddit.com).
Just go to any reddit thread and change the `reddit` in the URL to `removeddit` to see all removed comments.
-This is a done by comparing the comments being stored in [Jason Baumgartners](https://pushshift.io/) [Pushshift Reddit API](https://github.com/pushshift/api) and the ones from Reddit API. The frontend is written in [React](https://reactjs.org/) and uses [Sass](https://sass-lang.com/) as the CSS Preprocessor. There is also a seperate [backend](https://github.com/JubbeArt/removeddit-api) used for storing what threads that have been removed by mods.
+This is a done by comparing the comments being stored in [Jason Baumgartners](https://pushshift.io/) [Pushshift Reddit API](https://github.com/pushshift/api) and the ones from Reddit API. The frontend is written in [React](https://reactjs.org/) and uses [Sass](https://sass-lang.com/) as the CSS Preprocessor. There is also a seperate [backend](https://github.com/JubbeArt/removeddit-api) used for storing what threads that have been removed by mods. This backend is really just a mirror of [/r/undelete](https://www.reddit.com/r/undelete/).
# Development
Download either [Yarn](https://yarnpkg.com/en/docs/install) (the one I use) or [npm](https://www.npmjs.com/get-npm)
```bash
-sudo git clone https://github.com/JubbeArt/removeddit.git && cd removeddit
+git clone https://github.com/JubbeArt/removeddit.git && cd removeddit
-# npm...
npm install
npm start
-
-# or yarn
-yarn
-yarn start
```
This will build the Javascript files and launch a local server for development. Visit http://localhost:8080 and make sure the site is running.
The CSS is build seperatly (to keep the build steps / configs very simple) by running
```bash
-# npm
npm run build-sass
-
-# yarn
-yarn run build-sass
```
diff --git a/src/pages/about/index.js b/src/pages/about/index.js
index 88b3667..a864803 100644
--- a/src/pages/about/index.js
+++ b/src/pages/about/index.js
@@ -34,16 +34,16 @@ const About = props => {
Jesper Wrang and uses
Jason Baumgartner service for getting removed comments.
-
TODO
-
-
Collapsing comments
-
Maybe for specific users
-
+
FAQ
+ Q: I posted some sensitive information on Reddit. Can you delete this from your page?
+