aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorFeuerfuchs <git@feuerfuchs.dev>2019-06-27 08:17:53 +0200
committerFeuerfuchs <git@feuerfuchs.dev>2019-06-27 08:17:53 +0200
commitae24f8d092563e6267b8f4291eb84f5b33e56dfc (patch)
treecd8774667c5e789f109eaa25a132837702b2a754 /README.md
parentThat pre-commit hook still needs some work I guess (diff)
downloadgopherproxy-ae24f8d092563e6267b8f4291eb84f5b33e56dfc.tar.gz
gopherproxy-ae24f8d092563e6267b8f4291eb84f5b33e56dfc.tar.bz2
gopherproxy-ae24f8d092563e6267b8f4291eb84f5b33e56dfc.zip
Small fixes in the readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.md b/README.md
index 18353dc..1898572 100644
--- a/README.md
+++ b/README.md
@@ -10,12 +10,14 @@ Demo: https://gopher.feuerfuchs.dev/
10 10
11## Requirements 11## Requirements
12 12
13- libvips: Fast on-demand thumbnail generation 13- **libvips:** Fast on-demand thumbnail generation
14 14
15 15
16## Installation 16## Installation
17 17
18 $ go install git.feuerfuchs.dev/Feuerfuchs/gopherproxy/... 18```#!bash
19$ go install git.feuerfuchs.dev/Feuerfuchs/gopherproxy/...
20```
19 21
20 22
21## Usage 23## Usage
@@ -49,12 +51,12 @@ Folder structure:
49- **fonts:** Fonts that will be minified 51- **fonts:** Fonts that will be minified
50- **js:** TypeScript source files 52- **js:** TypeScript source files
51 53
52I recommend using a pre-commit hook that compiles all assets automatically: 54I recommend using a git pre-commit hook that compiles all assets automatically:
53 55
54```#!bash 56```#!bash
55#!/bin/sh 57#!/bin/sh
56 58
57exec make build 59make build
58git add -f assets 60git add -f assets
59exit 0 61exit 0
60``` 62```