From 774630ea141c1b74626a7e8b5b70267e096a3fee Mon Sep 17 00:00:00 2001
From: thisfro <jannis@thisfro.ch>
Date: Tue, 18 Jan 2022 20:25:49 +0100
Subject: [PATCH] Update docs

---
 DEVELOPMENT.md | 25 +++++++++++++++----------
 README.md      | 10 +++++++---
 2 files changed, 22 insertions(+), 13 deletions(-)

diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
index d08ddec..536ea42 100644
--- a/DEVELOPMENT.md
+++ b/DEVELOPMENT.md
@@ -3,9 +3,9 @@
 ## Prerequisites
 A good start is to follow this [intro](https://symfony.com/doc/current/the-fast-track/en/1-tools.html).
 
-In addition, you will need `yarn` and `npm`, as well as [`docker-compose`](https://docs.docker.com/compose/install/).
+In addition, you will need `yarn` and `npm`, as well as [`docker compose`](https://docs.docker.com/compose/install/).
 
-For that, install [`node.js`](https://nodejs.org/) by downloading directly or using your package manager.
+For that, install [`node.js`](https://nodejs.org/) by downloading directly or using your package manager (if you're using Linux, you probably knpw how to install).
 
 ### MacOS
 Using [homebrew](https://homebrew.sh):
@@ -22,19 +22,19 @@ choco install nodejs npm yarn
 ## Setup the project
 
 ### 1. Clone the repo
-Using SSH
+Using SSH ([set up your ssh-keys](https://git-scm.com/book/en/v2/Git-on-the-Server-Generating-Your-SSH-Public-Key) first or use https)
 ```
-git clone  ssh://git@git.thisfro.ch:222/thisfro/plant-exchange.git
+git clone  ssh://git@git.thisfro.ch:222/thisfro/pflaenz.li.git
 ```
 
 ### 2. Go to the directory
 ```
-cd plant-exchange
+cd pflaenz.li
 ```
 
 ### 3. Setup Database and other stuff
 ```
-docker-compose up -d
+docker compose up -d
 ```
 To create the database
 ```
@@ -61,17 +61,22 @@ symfony serve --port 8080 --no-tls -d
 
 You sholud be able to access the site under [localhost:8080](http://localhost:8080)
 
+You'll also need to build the webpack files (or use watch files):
+```
+yarn build
+```
 ### 6. Create a user
-Register your own account and set the `role` in the databse to `["ROLE"ADMIN"]`
+Register your own account and set the `role` in the databse to `["ROLE_ADMIN"]`
 
 ### 7. Watch files
-If you are editing `.scss` or other webpack files, you'll want to run
+If you are editing `.scss` or `.js`, you'll want to run
 ```
 yarn watch
 ```
+this will automatically rebuild webpack files on save.
 
 ---
 
-Thats it for now, you can start developing!
+Thats it for now, you can start developing! :tada:
 
-If you have any questions, ask [thisfro](https://git.thisfro.ch/thisfro) or creat an issue!
\ No newline at end of file
+If you have any questions, ask [thisfro](https://git.thisfro.ch/thisfro) or create an issue!
\ No newline at end of file
diff --git a/README.md b/README.md
index a8a91cd..4a94f13 100644
--- a/README.md
+++ b/README.md
@@ -7,12 +7,15 @@ A platform where people can exchange plants. They can post what they have and se
 - [Symfony](https://symfony.com/)
 - [MariaDB](https://www.mariadb.org)
 
-Deployment: TBD
-
 ## Admin dashboard
 Find it under `/admin`
 
 ## Filters
+
+### Implemented
+- Distance between postal codes
+
+### Ideas
 :warning: This list is work in progress!
 
 Searching with filters such as:
@@ -22,4 +25,5 @@ Searching with filters such as:
 | Name         | `string`      | textfield  |
 | Category     | `Category`    | dropdown   |
 
-Distance from entered ZIP to the offer ZIP.
+## Development
+To get started with development, see [DEVELOPMENT.md](DEVELOPMENT.md)
\ No newline at end of file