Skip to content

Commit d35d4b5

Browse files
committed
Update readme.
1 parent 902a608 commit d35d4b5

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ $ pip install cookiecutter
1212
```
1313
$ cookiecutter [email protected]:plotly/dash-component-boilerplate.git
1414
```
15+
The prompt will ask questions about the project, then it will create your project in a directory with the `project_shortname` variable.
16+
1517
3. Install dependencies
1618
```
1719
$ cd {{cookiecutter.project_shortname}}
@@ -82,7 +84,7 @@ $ cookiecutter [email protected]:plotly/dash-component-boilerplate.git
8284
$ python -m unittest tests.test_render
8385
```
8486
The Dash team uses these types of integration tests extensively. Browse the Dash component code on GitHub for more examples of testing (e.g. https://github.com/plotly/dash-core-components)
85-
- Publishing your component to NPM will make the JavaScript bundles available on the unpkg CDN. By default, Dash servers the component library's CSS and JS from the remote unpkg CDN, so if you haven't published the component package to NPM you'll need to set the `serve_locally` flags to `True`. We will eventually make `serve_locally=True` the default, [follow our progress in this issue](https://github.com/plotly/dash/issues/284).
87+
- Publishing your component to NPM will make the JavaScript bundles available on the unpkg CDN. By default, Dash serves the component library's CSS and JS from the remote unpkg CDN, so if you haven't published the component package to NPM you'll need to set the `serve_locally` flags to `True` (unless you choose `False` on `publish_on_npm`). We will eventually make `serve_locally=True` the default, [follow our progress in this issue](https://github.com/plotly/dash/issues/284).
8688
- Watch the [component boilerplate repository](https://github.com/plotly/dash-component-boilerplate) to stay informed of changes to our components.
8789
8890

{{cookiecutter.project_shortname}}/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ $ pip install cookiecutter
1212
```
1313
$ cookiecutter [email protected]:plotly/dash-component-boilerplate.git
1414
```
15+
The prompt will ask questions about the project, then it will create your project in a directory with the `project_shortname` variable.
16+
1517
3. Install dependencies
1618
```
1719
$ cd {{cookiecutter.project_shortname}}
@@ -82,7 +84,7 @@ $ cookiecutter [email protected]:plotly/dash-component-boilerplate.git
8284
$ python -m unittest tests.test_render
8385
```
8486
The Dash team uses these types of integration tests extensively. Browse the Dash component code on GitHub for more examples of testing (e.g. https://github.com/plotly/dash-core-components)
85-
- Publishing your component to NPM will make the JavaScript bundles available on the unpkg CDN. By default, Dash servers the component library's CSS and JS from the remote unpkg CDN, so if you haven't published the component package to NPM you'll need to set the `serve_locally` flags to `True`. We will eventually make `serve_locally=True` the default, [follow our progress in this issue](https://github.com/plotly/dash/issues/284).
87+
- Publishing your component to NPM will make the JavaScript bundles available on the unpkg CDN. By default, Dash servers the component library's CSS and JS from the remote unpkg CDN, so if you haven't published the component package to NPM you'll need to set the `serve_locally` flags to `True` (unless you choose `False` on `publish_on_npm`). We will eventually make `serve_locally=True` the default, [follow our progress in this issue](https://github.com/plotly/dash/issues/284).
8688
- Watch the [component boilerplate repository](https://github.com/plotly/dash-component-boilerplate) to stay informed of changes to our components.
8789
8890

0 commit comments

Comments
 (0)