Skip to content

Commit 742c755

Browse files
authored
docs: readme update (#29)
* docs: readme update * fix: remove extra quotes * fix: edit * 1.11.2
1 parent 200282d commit 742c755

File tree

3 files changed

+7
-8
lines changed

3 files changed

+7
-8
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ A lightweight tool for creating static custom HTTP error pages featuring a minim
3636
If you would like to obtain precompiled packages, please download the latest version from the [official website](https://sapachev.github.io/error-pages/#precompiled-packages).
3737

3838
The installation steps are following:
39-
1. Download the [package](https://sapachev.github.io/error-pages/#precompiled-packages) and extract the files
40-
2. Copy static HTML files from the `dist` directory to your server
41-
3. Copy and apply the configuration snippet from the `dist` to your web server configuration using the following line: `include /etc/nginx/snippets/nginx-error-pages.conf;`
39+
1. Download the [package](https://sapachev.github.io/error-pages/#precompiled-packages) and extract the files, and navigate to the `dist` directory
40+
2. Copy static HTML files and the `@assets` directory to the new `/usr/share/nginx/html/error-pages/` directory of your server
41+
3. Copy the `nginx-error-pages.conf` file to the existing `/etc/nginx/snippets/` directory and apply this snippet to your web server configuration using the following line: `include /etc/nginx/snippets/nginx-error-pages.conf;` (for detailed information, refer to the [Server Configurations](#server-configurations) section)
4242

4343

4444
## Basic Usage
@@ -48,8 +48,7 @@ Requirements: installed Node.js 11+
4848
1. Checkout this repository to your local machine
4949
2. Run `npm install --production` command to install dependencies
5050
3. Run `npm run build` command to compile error pages and web server configuration snippets
51-
4. Copy static HTML files from the `dist` directory to your server
52-
5. Copy and apply the configuration snippet from the `dist` to your web server configuration using the following line: `include /etc/nginx/snippets/nginx-error-pages.conf;`
51+
4. The same steps 2-3 outlined in the [Primitive Usage](#primitive-usage) section
5352

5453
```
5554
$ git clone [email protected]:sapachev/error-pages.git

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "error-pages",
3-
"version": "1.11.1",
3+
"version": "1.11.2",
44
"description": "Lightweight tool to create static HTTP Error Pages in minimalistic adaptive and accessible design with customization and localization support",
55
"main": "index.ts",
66
"scripts": {

0 commit comments

Comments
 (0)