From 999b11ba70b1711f602f4e58be7d933986a02e96 Mon Sep 17 00:00:00 2001 From: Pavel Sapachev Date: Fri, 27 Jan 2023 23:03:54 +0300 Subject: [PATCH] docs: update README (#4) * docs: update README * 1.0.2 --- README.md | 12 ++++++------ package-lock.json | 4 ++-- package.json | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4369bc7..ff07a2d 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Lightweight tool to create static HTTP Error Pages in minimalistic adaptive and * Customization * Localization (i18n) * Accessibility (a11y) -* Built-in web-server config generator (Nginx) +* Built-in web server config generator (Nginx) ![Screenshot](https://sapachev.com/share/error-pages/screenshot.png) @@ -32,10 +32,10 @@ Lightweight tool to create static HTTP Error Pages in minimalistic adaptive and Requirements: installed Node.js 11+ 1. Checkout this repository to your local machine -2. Run `npm i` command to install dependencies -3. Run `npm run build` command to compile error pages and config -4. Copy static html-files from `dist` directory to your server -5. Copy and apply config snippet from `dist` to your web-server configuration (see details below). +2. Run `npm install --production` command to install dependencies +3. Run `npm run build` command to compile error pages and web server configs +4. Copy static html files from `dist` directory to your server +5. Copy and apply config snippet from `dist` to your web server configuration (see details below). *Nginx* @@ -44,7 +44,7 @@ Nginx config located in `/dist//nginx-error-pages.conf` file and can be # How to improve default pages -* *Extensibility* A new pages can be added by adding new json-files in `scr/` directory. The page name must follow to format `.json` (`` is Number, related to specific HTTP status code). You can put any additional data to json-files, that you want to display on a page. In case of common variables, you can use `common.json` file to define them. +* *Extensibility* A new pages can be added by adding new json files in `scr/` directory. The page name must follow to format `.json` (`` is a number, related to specific HTTP status code). You can put any additional data to json files, that you want to display on a page. In case of common variables, you can use `common.json` file to define them. * *Customization* By editing default theme you can add anything you want. In case if you want to have own page design, you can create a new theme and apply it by editing `config.json` file. All assets (images, fonts, etc) must be placed to `@assets` directory (note: the `@assets` name is used to avoid a naming collision with default assets directory name in common cases). By default the [mustache.js](https://www.npmjs.com/package/mustache) is used as a template engine and [Tailwind](https://tailwindcss.com/) as a CSS framework. Entry point of Tailwind styles must be located in `themes//@assets/css/main.tcss` file. Custom Tailwind theme settings can be added to `theme.tailwind.config.js` file located in a root of theme directory. Also Tailwind can be disabled by editing `tailwind` option in `config.js`. * *Localization* If you need to change default text messages, then you can simply edit existing files in`src/` directory according to your needs. If you want to create your own localization, just simply add new locale directory and create set of source files. After new locale adding, change `locale` property in `config.json` file, located in a root. diff --git a/package-lock.json b/package-lock.json index 469640f..f376b64 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "error-pages", - "version": "1.0.1", + "version": "1.0.2", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "error-pages", - "version": "1.0.1", + "version": "1.0.2", "license": "ISC", "dependencies": { "@types/mustache": "^4.2.2", diff --git a/package.json b/package.json index c658569..0b391fa 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "error-pages", - "version": "1.0.1", + "version": "1.0.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": {