@tryghost/comments-ui 0.10.3 → 0.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -4,17 +4,19 @@
4
4
 
5
5
  This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
6
6
 
7
- ## Available Scripts
7
+ ## Basic Setup
8
8
 
9
- In the project directory, you can run:
9
+ This section is mostly relevant for core team only for active Comments development.
10
10
 
11
- ### `yarn start`
11
+ - Run `yarn start:dev` to start Comments in development mode
12
+ - Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
13
+ - To use the local Comments script in a local Ghost site
14
+ - Update `config.local.json` in Ghost repo to add "comments" config pointing to local dev server url as instructed on terminal.
15
+ - By default, this uses port `5368` for loading local Comments script on Ghost site. It's also possible to specify a custom port when running the script using - `--port=xxxx`.
12
16
 
13
- Runs the app in the development mode.\
14
- Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
17
+ ## Available Scripts
15
18
 
16
- The page will reload when you make changes.\
17
- You may also see any lint errors in the console.
19
+ In the project directory, you can run:
18
20
 
19
21
  ### `yarn test`
20
22
 
@@ -74,4 +76,4 @@ This section has moved here: [https://facebook.github.io/create-react-app/docs/t
74
76
 
75
77
  # Copyright & License
76
78
 
77
- Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE).
79
+ Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tryghost/comments-ui",
3
- "version": "0.10.3",
3
+ "version": "0.12.0",
4
4
  "license": "MIT",
5
5
  "repository": "git@github.com:TryGhost/comments-ui.git",
6
6
  "author": "Ghost Foundation",