OpenSourceArk/Ghost
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Tidied up package READMEs

Browse Source 
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
This commit is contained in:
Daniel Lockyer 2022-07-25 15:17:12 +02:00
parent 7c3ca9a26d
commit 308a28d31a
No known key found for this signature in database
GPG Key ID: D21186F0B47295AD
17 changed files with 0 additions and 609 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
ghost/custom-theme-settings-service/README.md
View File

@ -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).

31
ghost/domain-events/README.md
View File

@ -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

39
ghost/email-analytics-provider-mailgun/README.md
View File

@ -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).

39
ghost/email-analytics-service/README.md
View File

@ -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).

34
ghost/express-dynamic-redirects/README.md
View File

@ -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

36
ghost/magic-link/README.md
View File

@ -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).

34
ghost/member-analytics-service/README.md
View File

@ -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

31
ghost/member-events/README.md
View File

@ -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

39
ghost/members-analytics-ingress/README.md
View File

@ -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).

35
ghost/members-csv/README.md
View File

@ -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).

44
ghost/members-events-service/README.md
View File

@ -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).

39
ghost/members-importer/README.md
View File

@ -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).

36
ghost/members-ssr/README.md
View File

@ -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).

34
ghost/offers/README.md
View File

@ -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

34
ghost/payments/README.md
View File

@ -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

26
ghost/stripe/README.md
View File

@ -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

39
ghost/verification-trigger/README.md
View File

@ -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).