From dfa27799797d42edf6d17b5d51e6d9a8b86a6d12 Mon Sep 17 00:00:00 2001
From: Philipp Dormann <philipp@philippdormann.de>
Date: Sat, 22 May 2021 19:16:46 +0200
Subject: [PATCH] README cleanup

---
 .env.example |  1 +
 Dockerfile   |  2 +-
 README.md    | 22 ++++++++++------------
 3 files changed, 12 insertions(+), 13 deletions(-)
 create mode 100644 .env.example

diff --git a/.env.example b/.env.example
new file mode 100644
index 00000000..0864e1ca
--- /dev/null
+++ b/.env.example
@@ -0,0 +1 @@
+HASH_SALT=xSSHW4A2w0e3vxLUp46XL9OzCGKvxEnA
\ No newline at end of file
diff --git a/Dockerfile b/Dockerfile
index 6d4bebbd..cb5ebedd 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -5,5 +5,5 @@ COPY package.json /build/
 RUN yarn
 COPY . /build
 RUN yarn build
-RUN yarn prisma migrate dev
+# RUN yarn prisma migrate dev
 CMD ["yarn", "start"]
diff --git a/README.md b/README.md
index 724b85bd..5423bdd2 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
-# umami-sqlite
+# 🧭 umami-sqlite
 Modded version of [Umami Analytics](https://umami.is) backed by a local SQLite database
+> simple, fast, open source website analytics
 
-Umami is a simple, fast, website analytics alternative to Google Analytics.
-
-## Getting started
+## Quick Start
+### Requirements
 - Node.js >= 14.17.0
 
 ### Install Dependencies
@@ -12,31 +12,29 @@ Umami is a simple, fast, website analytics alternative to Google Analytics.
 yarn
 ```
 
-### Run db migration
+### (seemingly optional?) Run db migration
 ```
 yarn prisma migrate dev
 ```
 
-### Configure umami
+### Configure env
 
 Create an `.env` file with the following
 
 ```
-HASH_SALT=(any random string)
+HASH_SALT=anyrandomstring
 ```
 
 ### Build the application
 
 ```bash
-npm run build
+yarn build
 ```
 
 ### Start the application
 
 ```bash
-npm start
+yarn start
 ```
 
-By default this will launch the application on `http://localhost:3000`. You will need to either 
-[proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) requests from your web server
-or change the [port](https://nextjs.org/docs/api-reference/cli#production) to serve the application directly.
\ No newline at end of file
+The application will be available on `http://localhost:3000`.
\ No newline at end of file