Skip to content

Commit

Permalink
Update README, CHANGELOG and package.json for v1.2.2 release
Browse files Browse the repository at this point in the history
  • Loading branch information
daledavies committed Jun 30, 2022
1 parent 48bde6e commit 2ecec83
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 3 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-/
Expand Down
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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"]
},
Expand All @@ -149,15 +157,16 @@ 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
}
]
}

```

* `name` and `url` are mandatory.
* `tags`, `nofollow`, `newtab` and `icon` are optional.
* `description`, `tags`, `nofollow`, `newtab` and `icon` are optional.

#### Tags

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit 2ecec83

Please sign in to comment.