From 308a28d31a16becac0bf11eab927a565c3c7acfa Mon Sep 17 00:00:00 2001 From: Daniel Lockyer Date: Mon, 25 Jul 2022 15:17:12 +0200 Subject: [PATCH] Tidied up package READMEs refs https://github.com/TryGhost/Toolbox/issues/354 - these READMEs were migrated over from when each package was in a different repo - they also assume you're going to be publishing the packages because it mentions install instructions - only a few of them contain custom content - this commit deletes the majority of these files because they're now not useful - any that contained other instructions have been cut down --- ghost/custom-theme-settings-service/README.md | 39 ---------------- ghost/domain-events/README.md | 31 ------------- .../README.md | 39 ---------------- ghost/email-analytics-service/README.md | 39 ---------------- ghost/express-dynamic-redirects/README.md | 34 -------------- ghost/magic-link/README.md | 36 --------------- ghost/member-analytics-service/README.md | 34 -------------- ghost/member-events/README.md | 31 ------------- ghost/members-analytics-ingress/README.md | 39 ---------------- ghost/members-csv/README.md | 35 --------------- ghost/members-events-service/README.md | 44 ------------------- ghost/members-importer/README.md | 39 ---------------- ghost/members-ssr/README.md | 36 --------------- ghost/offers/README.md | 34 -------------- ghost/payments/README.md | 34 -------------- ghost/stripe/README.md | 26 ----------- ghost/verification-trigger/README.md | 39 ---------------- 17 files changed, 609 deletions(-) delete mode 100644 ghost/custom-theme-settings-service/README.md delete mode 100644 ghost/email-analytics-provider-mailgun/README.md delete mode 100644 ghost/email-analytics-service/README.md delete mode 100644 ghost/express-dynamic-redirects/README.md delete mode 100644 ghost/member-analytics-service/README.md delete mode 100644 ghost/members-analytics-ingress/README.md delete mode 100644 ghost/members-events-service/README.md delete mode 100644 ghost/members-importer/README.md delete mode 100644 ghost/offers/README.md delete mode 100644 ghost/payments/README.md delete mode 100644 ghost/stripe/README.md delete mode 100644 ghost/verification-trigger/README.md diff --git a/ghost/custom-theme-settings-service/README.md b/ghost/custom-theme-settings-service/README.md deleted file mode 100644 index 2cfb13d9d3..0000000000 --- a/ghost/custom-theme-settings-service/README.md +++ /dev/null @@ -1,39 +0,0 @@ -# Custom Theme Settings Service - -## Install - -`npm install @tryghost/custom-theme-settings-service --save` - -or - -`yarn add @tryghost/custom-theme-settings-service` - - -## Usage - - -## Develop - -This is a mono repository, managed with [lerna](https://lernajs.io/). - -Follow the instructions for the top-level repo. -1. `git clone` this repo & `cd` into it as usual -2. Run `yarn` to install top-level dependencies. - - -## Run - -- `yarn dev` - - -## Test - -- `yarn lint` run just eslint -- `yarn test` run lint and tests - - - - -# Copyright & License - -Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE). \ No newline at end of file diff --git a/ghost/domain-events/README.md b/ghost/domain-events/README.md index a88d5f6433..421c409dba 100644 --- a/ghost/domain-events/README.md +++ b/ghost/domain-events/README.md @@ -1,14 +1,5 @@ # Domain Events -## Install - -`npm install @tryghost/domain-events --save` - -or - -`yarn add @tryghost/domain-events` - - ## Usage ```js @@ -31,25 +22,3 @@ const event = new MyEvent('hello world'); DomainEvents.dispatch(event); ``` - - -## Develop - -This is a mono repository, managed with [lerna](https://lernajs.io/). - -Follow the instructions for the top-level repo. -1. `git clone` this repo & `cd` into it as usual -2. Run `yarn` to install top-level dependencies. - - -## Run - -- `yarn dev` - - -## Test - -- `yarn lint` run just eslint -- `yarn test` run lint and tests - - diff --git a/ghost/email-analytics-provider-mailgun/README.md b/ghost/email-analytics-provider-mailgun/README.md deleted file mode 100644 index 9df1ed63ca..0000000000 --- a/ghost/email-analytics-provider-mailgun/README.md +++ /dev/null @@ -1,39 +0,0 @@ -# Email Analytics Provider Mailgun - -## Install - -`npm install @tryghost/email-analytics-provider-mailgun --save` - -or - -`yarn add @tryghost/email-analytics-provider-mailgun` - - -## Usage - - -## Develop - -This is a mono repository, managed with [lerna](https://lernajs.io/). - -Follow the instructions for the top-level repo. -1. `git clone` this repo & `cd` into it as usual -2. Run `yarn` to install top-level dependencies. - - -## Run - -- `yarn dev` - - -## Test - -- `yarn lint` run just eslint -- `yarn test` run lint and tests - - - - -# Copyright & License - -Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE). \ No newline at end of file diff --git a/ghost/email-analytics-service/README.md b/ghost/email-analytics-service/README.md deleted file mode 100644 index a4290cfe0c..0000000000 --- a/ghost/email-analytics-service/README.md +++ /dev/null @@ -1,39 +0,0 @@ -# Email Analytics Service - -## Install - -`npm install @tryghost/email-analytics-service --save` - -or - -`yarn add @tryghost/email-analytics-service` - - -## Usage - - -## Develop - -This is a mono repository, managed with [lerna](https://lernajs.io/). - -Follow the instructions for the top-level repo. -1. `git clone` this repo & `cd` into it as usual -2. Run `yarn` to install top-level dependencies. - - -## Run - -- `yarn dev` - - -## Test - -- `yarn lint` run just eslint -- `yarn test` run lint and tests - - - - -# Copyright & License - -Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE). diff --git a/ghost/express-dynamic-redirects/README.md b/ghost/express-dynamic-redirects/README.md deleted file mode 100644 index 6b132606e1..0000000000 --- a/ghost/express-dynamic-redirects/README.md +++ /dev/null @@ -1,34 +0,0 @@ -# Express Dynamic Redirects - -## Install - -`npm install @tryghost/express-dynamic-redirects --save` - -or - -`yarn add @tryghost/express-dynamic-redirects` - - -## Usage - - -## Develop - -This is a mono repository, managed with [lerna](https://lernajs.io/). - -Follow the instructions for the top-level repo. -1. `git clone` this repo & `cd` into it as usual -2. Run `yarn` to install top-level dependencies. - - -## Run - -- `yarn dev` - - -## Test - -- `yarn lint` run just eslint -- `yarn test` run lint and tests - - diff --git a/ghost/magic-link/README.md b/ghost/magic-link/README.md index c5406938f9..e780eeacac 100644 --- a/ghost/magic-link/README.md +++ b/ghost/magic-link/README.md @@ -1,14 +1,5 @@ # Magic Link -## Install - -`npm install @tryghost/magic-link --save` - -or - -`yarn add @tryghost/magic-link` - - ## Usage ```js @@ -67,30 +58,3 @@ async function main() { main(); ``` - - -## Develop - -This is a mono repository, managed with [lerna](https://lernajs.io/). - -Follow the instructions for the top-level repo. -1. `git clone` this repo & `cd` into it as usual -2. Run `yarn` to install top-level dependencies. - - -## Run - -- `yarn dev` - - -## Test - -- `yarn lint` run just eslint -- `yarn test` run lint and tests - - - - -# Copyright & License - -Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE). diff --git a/ghost/member-analytics-service/README.md b/ghost/member-analytics-service/README.md deleted file mode 100644 index 7174e531ce..0000000000 --- a/ghost/member-analytics-service/README.md +++ /dev/null @@ -1,34 +0,0 @@ -# Member Analytics Service - -## Install - -`npm install @tryghost/member-analytics-service --save` - -or - -`yarn add @tryghost/member-analytics-service` - - -## Usage - - -## Develop - -This is a mono repository, managed with [lerna](https://lernajs.io/). - -Follow the instructions for the top-level repo. -1. `git clone` this repo & `cd` into it as usual -2. Run `yarn` to install top-level dependencies. - - -## Run - -- `yarn dev` - - -## Test - -- `yarn lint` run just eslint -- `yarn test` run lint and tests - - diff --git a/ghost/member-events/README.md b/ghost/member-events/README.md index f8da82e3b9..3b8e36f387 100644 --- a/ghost/member-events/README.md +++ b/ghost/member-events/README.md @@ -1,14 +1,5 @@ # Member Events -## Install - -`npm install @tryghost/member-events --save` - -or - -`yarn add @tryghost/member-events` - - ## Usage ``` @@ -25,25 +16,3 @@ const DomainEvents = require('@tryghost/domain-events'); DomainEvents.dispatch(event); ``` - - -## Develop - -This is a mono repository, managed with [lerna](https://lernajs.io/). - -Follow the instructions for the top-level repo. -1. `git clone` this repo & `cd` into it as usual -2. Run `yarn` to install top-level dependencies. - - -## Run - -- `yarn dev` - - -## Test - -- `yarn lint` run just eslint -- `yarn test` run lint and tests - - diff --git a/ghost/members-analytics-ingress/README.md b/ghost/members-analytics-ingress/README.md deleted file mode 100644 index c37ab7fb69..0000000000 --- a/ghost/members-analytics-ingress/README.md +++ /dev/null @@ -1,39 +0,0 @@ -# Events Controller - -## Install - -`npm install @tryghost/members-analytics-ingress --save` - -or - -`yarn add @tryghost/members-analytics-ingress` - - -## Usage - - -## Develop - -This is a mono repository, managed with [lerna](https://lernajs.io/). - -Follow the instructions for the top-level repo. -1. `git clone` this repo & `cd` into it as usual -2. Run `yarn` to install top-level dependencies. - - -## Run - -- `yarn dev` - - -## Test - -- `yarn lint` run just eslint -- `yarn test` run lint and tests - - - - -# Copyright & License - -Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE). diff --git a/ghost/members-csv/README.md b/ghost/members-csv/README.md index 225b4e1e10..6a2b893d1e 100644 --- a/ghost/members-csv/README.md +++ b/ghost/members-csv/README.md @@ -1,14 +1,5 @@ # Members Csv -## Install - -`npm install @tryghost/members-csv --save` - -or - -`yarn add @tryghost/members-csv` - - ## Usage There are 2 parts to this package: CSV to JSON serialization and JSON to CSV serialization. The module exposes 2 methods to fullfil these: `parse` and `unparse` respectively. @@ -48,29 +39,3 @@ const membersCSV = unparse(members); console.log(membersCSV); // -> "id,email,name,note,subscribed_to_emails,complimentary_plan,stripe_customer_id,created_at,deleted_at,labels\r\n,email@example.com,Sam Memberino,Early supporter,,,,,," ``` - -## Develop - -This is a mono repository, managed with [lerna](https://lernajs.io/). - -Follow the instructions for the top-level repo. -1. `git clone` this repo & `cd` into it as usual -2. Run `yarn` to install top-level dependencies. - - -## Run - -- `yarn dev` - - -## Test - -- `yarn lint` run just eslint -- `yarn test` run lint and tests - - - - -# Copyright & License - -Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE). diff --git a/ghost/members-events-service/README.md b/ghost/members-events-service/README.md deleted file mode 100644 index 4860b6497a..0000000000 --- a/ghost/members-events-service/README.md +++ /dev/null @@ -1,44 +0,0 @@ -# Members events service - - -Contains member services that listen on specific events to perform actions: - -- Last-seen-at updater: Updates `members.last_seen_at` on a page/post view event - -## Install - -`npm install @tryghost/members-events-service --save` - -or - -`yarn add @tryghost/members-events-service` - - -## Usage - - -## Develop - -This is a mono repository, managed with [lerna](https://lernajs.io/). - -Follow the instructions for the top-level repo. -1. `git clone` this repo & `cd` into it as usual -2. Run `yarn` to install top-level dependencies. - - -## Run - -- `yarn dev` - - -## Test - -- `yarn lint` run just eslint -- `yarn test` run lint and tests - - - - -# Copyright & License - -Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE). diff --git a/ghost/members-importer/README.md b/ghost/members-importer/README.md deleted file mode 100644 index 30129564bf..0000000000 --- a/ghost/members-importer/README.md +++ /dev/null @@ -1,39 +0,0 @@ -# Members Importer - -## Install - -`npm install @tryghost/members-importer --save` - -or - -`yarn add @tryghost/members-importer` - - -## Usage - - -## Develop - -This is a mono repository, managed with [lerna](https://lernajs.io/). - -Follow the instructions for the top-level repo. -1. `git clone` this repo & `cd` into it as usual -2. Run `yarn` to install top-level dependencies. - - -## Run - -- `yarn dev` - - -## Test - -- `yarn lint` run just eslint -- `yarn test` run lint and tests - - - - -# Copyright & License - -Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE). \ No newline at end of file diff --git a/ghost/members-ssr/README.md b/ghost/members-ssr/README.md index b0a6f3819e..16c424d0b7 100644 --- a/ghost/members-ssr/README.md +++ b/ghost/members-ssr/README.md @@ -1,14 +1,5 @@ # Members Ssr -## Install - -`npm install members-ssr --save` - -or - -`yarn add members-ssr` - - ## Usage ```js @@ -53,30 +44,3 @@ require('http').createServer((req, res) => { } }).listen(3665); ``` - - -## Develop - -This is a mono repository, managed with [lerna](https://lernajs.io/). - -Follow the instructions for the top-level repo. -1. `git clone` this repo & `cd` into it as usual -2. Run `yarn` to install top-level dependencies. - - -## Run - -- `yarn dev` - - -## Test - -- `yarn lint` run just eslint -- `yarn test` run lint and tests - - - - -# Copyright & License - -Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE). diff --git a/ghost/offers/README.md b/ghost/offers/README.md deleted file mode 100644 index 59d798531c..0000000000 --- a/ghost/offers/README.md +++ /dev/null @@ -1,34 +0,0 @@ -# Offers - -## Install - -`npm install @tryghost/offers --save` - -or - -`yarn add @tryghost/offers` - - -## Usage - - -## Develop - -This is a mono repository, managed with [lerna](https://lernajs.io/). - -Follow the instructions for the top-level repo. -1. `git clone` this repo & `cd` into it as usual -2. Run `yarn` to install top-level dependencies. - - -## Run - -- `yarn dev` - - -## Test - -- `yarn lint` run just eslint -- `yarn test` run lint and tests - - diff --git a/ghost/payments/README.md b/ghost/payments/README.md deleted file mode 100644 index fbb05f713e..0000000000 --- a/ghost/payments/README.md +++ /dev/null @@ -1,34 +0,0 @@ -# Payments - -## Install - -`npm install @tryghost/payments --save` - -or - -`yarn add @tryghost/payments` - - -## Usage - - -## Develop - -This is a mono repository, managed with [lerna](https://lernajs.io/). - -Follow the instructions for the top-level repo. -1. `git clone` this repo & `cd` into it as usual -2. Run `yarn` to install top-level dependencies. - - -## Run - -- `yarn dev` - - -## Test - -- `yarn lint` run just eslint -- `yarn test` run lint and tests - - diff --git a/ghost/stripe/README.md b/ghost/stripe/README.md deleted file mode 100644 index 61d40990c6..0000000000 --- a/ghost/stripe/README.md +++ /dev/null @@ -1,26 +0,0 @@ -# Stripe Service - -## Install - -`npm install @tryghost/members-stripe-service --save` - -or - -`yarn add @tryghost/members-stripe-service` - - -## Usage - - -## Develop - -This is a mono repository, managed with [lerna](https://lernajs.io/). - -Follow the instructions for the top-level repo. -1. `git clone` this repo & `cd` into it as usual -2. Run `yarn` to install top-level dependencies. - -## Test - -- `yarn lint` run just eslint -- `yarn test` run lint and tests diff --git a/ghost/verification-trigger/README.md b/ghost/verification-trigger/README.md deleted file mode 100644 index 83be55a102..0000000000 --- a/ghost/verification-trigger/README.md +++ /dev/null @@ -1,39 +0,0 @@ -# Verification Trigger - -## Install - -`npm install @tryghost/verification-trigger --save` - -or - -`yarn add @tryghost/verification-trigger` - - -## Usage - - -## Develop - -This is a mono repository, managed with [lerna](https://lernajs.io/). - -Follow the instructions for the top-level repo. -1. `git clone` this repo & `cd` into it as usual -2. Run `yarn` to install top-level dependencies. - - -## Run - -- `yarn dev` - - -## Test - -- `yarn lint` run just eslint -- `yarn test` run lint and tests - - - - -# Copyright & License - -Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE). \ No newline at end of file