@hellocoop/quickstart 1.0.21 → 1.0.22

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.
Files changed (2) hide show
  1. package/README.md +15 -15
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -3,32 +3,32 @@
3
3
  ## CLI
4
4
 
5
5
  You can run the following command to create or retrieve the `client_id` for a Hellō Application.
6
-
7
- `npx @hellocoop/quickstart@latest`
6
+ ```sh
7
+ npx @hellocoop/quickstart@latest
8
+ ```
8
9
 
9
10
  This will open up a browser window, where you will need to login with Hellō, and then choose to create a new app, or return the `client_id`.
10
11
 
11
12
  ## Import Package
12
13
 
13
- To install in another package
14
+ This package is useful for platform specific installers such as [Hellō Quickstart for Next.js](https://www.npmjs.com/package/@hellocoop/quickstart-nextjs)
14
15
 
15
- `npm i @hellocoop/quickstart`
16
-
17
- or
16
+ To install in another package
18
17
 
19
- `yarn i @hellocoop/quickstart`
18
+ ```sh
19
+ npm i --save-dev @hellocoop/quickstart
20
+ ```
20
21
 
21
22
  You can then use call Quickstart fom another configuration script
22
23
 
23
- ```
24
- import quickstart from './quickstart.js';
24
+ ```javascript
25
+ import quickstart from '@hellocoop/quickstart';
25
26
 
26
27
  ...
27
-
28
- const client_id = await quickstart()
28
+ const response_uri = 'http://localhost:8080'
29
+ const client_id = await quickstart({
30
+ response_uri
31
+ })
29
32
 
30
33
  ```
31
-
32
- ## Options
33
-
34
- TBD
34
+ There are many options that can be passed to Quickstart. See the [Quickstart API](https://www.hello.dev/documentation/management-apis.html#quickstart-api) for details.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hellocoop/quickstart",
3
- "version": "1.0.21",
3
+ "version": "1.0.22",
4
4
  "description": "A CLI and module to start the Hello Quickstart web app and return a client_id",
5
5
  "main": "index.js",
6
6
  "bin": {