Skip to content

Commit c18bd04

Browse files
Merge pull request #7 from Space48/fix-readme
Update readme with correct usage
2 parents a45d1ff + a974605 commit c18bd04

File tree

1 file changed

+2
-61
lines changed

1 file changed

+2
-61
lines changed

README.md

+2-61
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Widget Builder [![CircleCi](https://circleci.com/gh/bigcommerce/widget-builder.svg?style=svg&circle-token=b4d4a370c5cdee3585da202fd0e81a9febbb6059)](https://circleci.com/gh/bigcommerce/widget-builder)
1+
# Widget Builder
22

33
<div class="otp" id="no-index">
44

@@ -20,8 +20,7 @@ This article contains detailed instructions on how to get started with Widget Bu
2020

2121
## Prerequisites
2222

23-
* Node.js 14
24-
* npm 6.14
23+
* Node.js 18
2524
* [A BigCommerce store](https://support.bigcommerce.com/s/article/Starting-a-Bigcommerce-Trial).
2625
* API `access_token` with `content modify` scope. For information on how to generate store API credentials, see [Obtaining store API credentials](https://developer.bigcommerce.com/api-docs/getting-started/authentication/rest-api-authentication#obtaining-store-api-credentials).
2726

@@ -50,10 +49,6 @@ Usage: widget-builder [options] [command]
5049

5150
Options:
5251
-V, --version output the version number
53-
--gen-config generate a config.json file
54-
--gen-query-params generate a queryParams.json file
55-
--auto-open <flag> open browser automatically to the builder
56-
preview (default: "true")
5752
-h, --help display help for command
5853

5954
Commands:
@@ -66,18 +61,6 @@ Commands:
6661
help [command] display help for command
6762
```
6863

69-
<div class="HubBlock--callout">
70-
<div class="CalloutBlock--info">
71-
<div class="HubBlock-content">
72-
73-
<!-- theme: info -->
74-
75-
> Refer to [Widget Builder README.MD](https://github.com/bigcommerce/widget-builder) for the latest supported `node` version.
76-
77-
</div>
78-
</div>
79-
</div>
80-
8164
## Configuring Widget Builder
8265

8366
Once you have installed Widget Builder, the next step is to set up your store's environment. You will need the store's Client ID, Access Token, and API Path to generate appropriate configurations.
@@ -90,24 +73,7 @@ widget-builder init
9073

9174
When prompted, enter your API account credentials. This will create the `.env` file with the necessary parameter assignments.
9275

93-
**Sample output:**
94-
95-
```shell
96-
Thank you for using Widget Builder
97-
98-
99-
This guide will help you get your environment set up.
100-
101-
Before continuing, please make sure you've created or received a Store API account.
102-
You'll need those credentials in order to generate the appropriate configurations.
103-
You can find more information here. https://support.bigcommerce.com/s/article/Store-API-Accounts#creating
10476

105-
? Are you ready to continue? You may press any key to continue Yes
106-
? What is the Client ID? xxxxxxxxxxxxx
107-
? What is the Access Token? xxxxxxxxxxxxx
108-
? What is the API Path? https://api.bigcommerce.com/stores/xxxxx/v3/
109-
[2021-09-08T15:12:40.271Z] Successfully created your configuration, you're all set!
110-
```
11177
### Resetting configurations
11278

11379
If you need to reset the configurations, run the `widget-builder init` command to overwrite the existing assignments.
@@ -150,28 +116,3 @@ To publish a widget to your BigCommerce store, run the following command:
150116
widget-builder publish [path to widget template]
151117
```
152118

153-
## Contributions
154-
155-
If you wish to contribute, please refer to our [contribution guide](CONTRIBUTING.md)
156-
and [code of conduct](CODE_OF_CONDUCT.md) for this project.
157-
158-
## Issues / Bugs
159-
160-
* Please include a clear, specific title and replicable description.
161-
162-
* Please include your environment, OS, and any exceptions/backtraces that occur. The more
163-
information that is given, the more likely we can debug and fix the issue.
164-
165-
**If you find a security bug, please do not post as an issue. Send directly to [[email protected]](mailto:[email protected])
166-
instead.**
167-
168-
Thank you again for your interest in contributing to the Widget Builder!
169-
170-
Copyright (C) 2019-Present BigCommerce Inc. All rights reserved.
171-
172-
## Resources
173-
174-
* [Authenticating BigCommerce's REST APIs](https://developer.bigcommerce.com/api-docs/getting-started/authentication/rest-api-authentication)
175-
* [Widgets API Overview](https://developer.bigcommerce.com/api-docs/store-management/widgets/overview)
176-
* [Widget Builder GitHub repository](https://github.com/bigcommerce/widget-builder)
177-

0 commit comments

Comments
 (0)