Skip to content

Commit c59567c

Browse files
author
Xing Han Lu
authored
Merge pull request #118 from plotly/update-readme
Minor updates to the README.md
2 parents 5344fdd + 94697c8 commit c59567c

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

+14-7
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This repository contains a [Cookiecutter](https://github.com/audreyr/cookiecutter) template to create your own Dash components.
44

5+
- New to Dash? Check out the [official Dash Documentations](https://dash.plotly.com)
6+
- If it's the first time creating a Dash component, start with our [React guide for Python developers](https://dash.plotly.com/react-for-python-developers)
7+
- Need help with your component? Create a post on the [Dash Community Forum](https://community.plotly.com/c/dash)
8+
59
## Usage
610

711
To use this boilerplate:
@@ -14,7 +18,7 @@ To use this boilerplate:
1418
[Node.js/npm is also required.](https://nodejs.org/en/)
1519
2. Run cookiecutter on the boilerplate repo:
1620
```
17-
$ cookiecutter https://github.com/plotly/dash-component-boilerplate.git
21+
$ cookiecutter gh:plotly/dash-component-boilerplate
1822
```
1923
3. Answer the questions about the project.
2024
- `project_name`: This is the "human-readable" name of your project. For example, "Dash Core Components".
@@ -39,10 +43,13 @@ to generate the components in the `build:backends` script of the generated
3943
4044
## More Resources
4145
42-
- Learn more about Dash: https://dash.plotly.com
43-
- Questions about this project? Create an issue: https://github.com/plotly/dash-component-boilerplate/issues/new
46+
- Found a bug or have a feature request? [Create an issue](https://github.com/plotly/dash-component-boilerplate/issues/new)
4447
- Watch the [component boilerplate repository](https://github.com/plotly/dash-component-boilerplate) to stay informed of changes to our components.
45-
- [React guide for Python developers](https://dash.plotly.com/react-for-python-developers)
46-
- Need help with your component? View the Dash Community Forum: https://community.plotly.com/c/dash
47-
- Examples of Dash component libraries include `dash-core-components`: https://github.com/plotly/dash-core-components and `dash-html-components`: https://github.com/plotly/dash-html-components.
48-
- To get a feel for what's involved in creating a component, read through the [README.MD file that this cookiecutter project generates](%7B%7Bcookiecutter.project_shortname%7D%7D/README.md)
48+
- To get a feel for what's involved in creating a component, read the [README.md generated by this cookiecutter](%7B%7Bcookiecutter.project_shortname%7D%7D/README.md)
49+
- Examples of Dash component libraries include:
50+
- [`dash-core-components`](https://github.com/plotly/dash-core-components)
51+
- [`dash-html-components`](https://github.com/plotly/dash-html-components)
52+
- [`dash-cytoscape`](https://github.com/plotly/dash-cytoscape)
53+
- [`dash-deck`](https://github.com/plotly/dash-deck)
54+
- [Curated community-made components](https://plotly.com/dash-community-components/)
55+

0 commit comments

Comments
 (0)