@dialpad/dialtone-vue
Advanced tools
Comparing version 1.0.0 to 1.0.1
{ | ||
"name": "@dialpad/dialtone-vue", | ||
"version": "1.0.0", | ||
"version": "1.0.1", | ||
"description": "Vue component library for Dialtone components", | ||
@@ -17,3 +17,5 @@ "repository": "https://github.com/dialpad/dialtone-vue", | ||
"lint:code": "esplint ./", | ||
"lint-staged:code": "eslint --fix", | ||
"lint:docs": "markdownlint '**/*.mdx'", | ||
"lint-staged:docs": "markdownlint --fix", | ||
"lint": "run-s lint:code lint:docs", | ||
@@ -28,4 +30,3 @@ "storybook": "npm run --prefix storybook storybook", | ||
"devDependencies": { | ||
"@dialpad/dialtone": "6.0.0", | ||
"@dialpad/generator-dp": "^1.0.0", | ||
"@dialpad/dialtone": "^6.1.0", | ||
"@vue/cli-plugin-babel": "~4.4.6", | ||
@@ -56,2 +57,3 @@ "@vue/cli-plugin-eslint": "~4.4.6", | ||
"less-loader": "^6.2.0", | ||
"lint-staged": "^11.1.2", | ||
"markdownlint": "^0.22.0", | ||
@@ -74,3 +76,3 @@ "markdownlint-cli": "^0.26.0", | ||
"gitHooks": { | ||
"pre-commit": "npm run lint" | ||
"pre-commit": "lint-staged" | ||
}, | ||
@@ -77,0 +79,0 @@ "engineStrict": true, |
@@ -5,3 +5,3 @@ # Dialtone Vue 📞 | ||
**[Component Documentation Site ↗️][handbook]** | ||
**[Component Documentation Site ↗️][dialtone-vue]** | ||
@@ -12,10 +12,6 @@ [dt]: https://dialpad.design | ||
Dialtone Vue is a new project, and as such it is under constant development as we add new components and refine existing ones. Please refer to the [project board][project] to see the status of Dialtone Vue components and request new components that should be in the Dialtone Vue library. | ||
Dialtone Vue is a new project, and as such it is under constant development as we add new components and refine existing ones. Please refer to the [jira board][jira] to see the status of Dialtone Vue components and request new components that should be in the Dialtone Vue library. | ||
[project]: https://github.com/orgs/dialpad/projects/1 | ||
[jira]: https://switchcomm.atlassian.net/secure/RapidBoard.jspa?rapidView=246 | ||
### Timeline | ||
Our goal is to have a stable 1.0 release in Q3 2021. At this point, we will split Dialtone Vue into a separate repository and follow semantic versioning. | ||
## Usage | ||
@@ -31,3 +27,3 @@ | ||
Dialtone Vue uses [Storybook][storybook] for documentation of components, as well as an environment for local development. Please see the [Storybook Documentation Site][handbook] for specific usage information and interactive documentation for each Dialtone Vue component. | ||
Dialtone Vue uses [Storybook][storybook] for documentation of components, as well as an environment for local development. Please see the [Storybook Documentation Site][dialtone-vue] for specific usage information and interactive documentation for each Dialtone Vue component. | ||
@@ -37,4 +33,4 @@ All components in Dialtone Vue should have stories written for them in Storybook. For more information on how to write stories, see the [documentation][stories]. | ||
[storybook]: https://storybook.js.org | ||
[handbook]: https://dialtone-vue.netlify.app | ||
[stories]: https://dialtone-vue.netlify.app/?path=/story/docs-storybook-getting-started--page | ||
[dialtone-vue]: https://vue.dialpad.design | ||
[stories]: https://vue.dialpad.design/?path=/story/docs-storybook-getting-started--page | ||
@@ -67,6 +63,2 @@ ### Running Storybook Locally | ||
#### NPM_AUTH_TOKEN | ||
Ensure that `NPM_AUTH_TOKEN` is set in your path. You will need to set the token to an NPM authentication token which has read level access to the `@dialpad` organization. | ||
#### Install Dependencies | ||
@@ -82,5 +74,5 @@ | ||
If needed, you can also write custom CSS using the Dialtone LESS variables or mixins by importing `../css/dialtone.less`. | ||
If needed, you can also write custom CSS using Dialtone LESS variables by importing `../css/dialtone.less`. | ||
Please **do not** use any scoped CSS in Dialtone Vue components. | ||
Please **do not** use any scoped CSS or mixins in Dialtone Vue components. | ||
@@ -87,0 +79,0 @@ ### Unit Tests |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
491722
12034
109