From 2ecec8337705634691dbfdc955e36aa7b7d6b05d Mon Sep 17 00:00:00 2001 From: Dale Davies Date: Thu, 30 Jun 2022 15:39:27 +0100 Subject: [PATCH] Update README, CHANGELOG and package.json for v1.2.2 release --- CHANGELOG.md | 9 +++++++++ README.md | 13 +++++++++++-- package.json | 2 +- 3 files changed, 21 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 19c2a9f..94ac91c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [1.2.2] - 2022-06-30 +### Added +- Issue #35: Add optional WWWURL config param +- Issue #37: Add ALTBGPROVIDER config option +- Issue #38: Add optional description to sites + +### Fixed +- Issue #36: Improve use of cache to avoid waiting for lock timeout + ## [1.2.1] - 2022-06-07 ### Fixed - Fix incorrect keyup check for ctrl-shift-/ diff --git a/README.md b/README.md index 4cff2ff..0a442f1 100644 --- a/README.md +++ b/README.md @@ -58,11 +58,13 @@ You can use the following optional environment variables to configure/customise - `BGBRIGHT: 90` - Background image brightness percentage. - `UNSPLASHAPIKEY` - An API key for Unsplash, enables fetching random background images from Unsplash. - `UNSPLASHCOLLECTIONS` - List of Unsplash collection ID's (separated by commas) to select random images from. +- `ALTBGPROVIDER` - An alternative background provider url. - `OWMAPIKEY` - An API key for Open Weather Map, LATLONG (below) must also be defined. - `LATLONG` - A latitude and longitude for the default location (e.g. "51.509865,-0.118092"). - `METRICTEMP: 'true'` - Metric (C) or imperial (F) temperature units. - `NOINDEX: 'true'` - Include a robots noindex meta tag in site header - `CACHEBYPASS: 'true'` - Bypass all caches, useful for testing changes. +- `WWWURL` - Useful if Jump is hosted in a sub-directory. **NOTE:** The `OWMAPIKEY` and `LATLONG` config options must be defined together. @@ -120,12 +122,18 @@ Edit the `/sites/sites.json` file to include your own sites on the startpage... { "name": "Github", "url" : "https://github.com/daledavies/jump", + "description": "This is an example description", "nofollow": false, "newtab": true }, + { + "name": "Docker Hub", + "url" : "https://hub.docker.com/r/daledavies/jump" + }, { "name": "Bitwarden", "url" : "https://bitwarden.example.com", + "description": "This is another example of a site with a description", "icon": "bitwarden.png", "tags": ["stuff"] }, @@ -149,7 +157,8 @@ Edit the `/sites/sites.json` file to include your own sites on the startpage... }, { "name": "Google", - "url" : "https://www.google.com" + "url" : "https://www.google.com", + "nofollow": false } ] } @@ -157,7 +166,7 @@ Edit the `/sites/sites.json` file to include your own sites on the startpage... ``` * `name` and `url` are mandatory. -* `tags`, `nofollow`, `newtab` and `icon` are optional. +* `description`, `tags`, `nofollow`, `newtab` and `icon` are optional. #### Tags diff --git a/package.json b/package.json index 73728ea..bd63ca7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "jump", - "version": "1.2.1", + "version": "1.2.2", "description": "Jump is yet another self-hosted startpage for your server designed to be simple, stylish, fast and secure.", "scripts": { "dev": "webpack --mode=development --devtool=inline-source-map --watch",