History

Naz 2cd6cd9140 Documented notifications api parameter refs https://github.com/TryGhost/Team/issues/728 - This was missing from the JSDoc		2021-06-03 13:04:47 +04:00
..
lib	Documented notifications api parameter	2021-06-03 13:04:47 +04:00
test	Fixed tests	2021-06-02 18:22:54 +04:00
.eslintrc.js	Added update check service initial commit	2021-06-02 18:17:56 +04:00
LICENSE	Added update check service initial commit	2021-06-02 18:17:56 +04:00
package.json	Added missing module dependencies for update-check-service	2021-06-02 18:25:15 +04:00
README.md	Added update check service initial commit	2021-06-02 18:17:56 +04:00

README.md

Update Check Service

Makes a request to updates.ghost.org to check for release & custom notifications. The service is provided in return for users opting in to anonymous usage data collection.

Install

npm install @tryghost/update-check-service --save

yarn add @tryghost/update-check-service

Usage

Develop

This is a mono repository, managed with lerna.

Follow the instructions for the top-level repo.

git clone this repo & cd into it as usual
Run yarn to install top-level dependencies.

Run

yarn dev

Test

yarn lint run just eslint
yarn test run lint and tests