Skip to content

Commit

Permalink
docs: readme update (#29)
Browse files Browse the repository at this point in the history
* docs: readme update

* fix: remove extra quotes

* fix: edit

* 1.11.2
  • Loading branch information
sapachev authored Nov 22, 2024
1 parent 200282d commit 742c755
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 8 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ A lightweight tool for creating static custom HTTP error pages featuring a minim
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).

The installation steps are following:
1. Download the [package](https://sapachev.github.io/error-pages/#precompiled-packages) and extract the files
2. Copy static HTML files from the `dist` directory to your server
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;`
1. Download the [package](https://sapachev.github.io/error-pages/#precompiled-packages) and extract the files, and navigate to the `dist` directory
2. Copy static HTML files and the `@assets` directory to the new `/usr/share/nginx/html/error-pages/` directory of your server
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)


## Basic Usage
Expand All @@ -48,8 +48,7 @@ Requirements: installed Node.js 11+
1. Checkout this repository to your local machine
2. Run `npm install --production` command to install dependencies
3. Run `npm run build` command to compile error pages and web server configuration snippets
4. Copy static HTML files from the `dist` directory to your server
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;`
4. The same steps 2-3 outlined in the [Primitive Usage](#primitive-usage) section

```
$ git clone [email protected]:sapachev/error-pages.git
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "error-pages",
"version": "1.11.1",
"version": "1.11.2",
"description": "Lightweight tool to create static HTTP Error Pages in minimalistic adaptive and accessible design with customization and localization support",
"main": "index.ts",
"scripts": {
Expand Down

0 comments on commit 742c755

Please sign in to comment.