@dialpad/dialtone-icons 0.0.10 → 0.0.12-vue3

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 (7) hide show
  1. package/README.md +26 -17
  2. package/dist/dialtone-icons.common.js +12453 -19834
  3. package/dist/dialtone-icons.umd.js +12464 -19838
  4. package/dist/dialtone-icons.umd.min.js +1 -1
  5. package/dist/icons.json +1980 -0
  6. package/dist/svg/transfer-webchat.svg +1 -0
  7. package/package.json +6 -5
package/README.md CHANGED
@@ -1,29 +1,38 @@
1
- # dialtone-icons
1
+ # Dialtone Icons
2
2
 
3
- ## Project setup
4
- ```
5
- npm install
6
- ```
3
+ This is the home for Dialtone icons. It includes the resources needed to implement icons on your application that conform to Dialpad’s design principles and best practices.
7
4
 
8
- ### Compiles and hot-reloads for development
9
- ```
10
- npm run serve
11
- ```
5
+ ## Install Dialtone icons via NPM
6
+
7
+ To add Dialtone icons into your project, you can install it via NPM:
12
8
 
13
- ### Compiles and minifies for production
9
+ **For Vue 2 projects:**
14
10
  ```
15
- npm run build
11
+ npm install --save @dialpad/dialtone-icons
16
12
  ```
17
13
 
18
- ### Run your unit tests
14
+ **For Vue 3 projects:**
19
15
  ```
20
- npm run test:unit
16
+ npm install --save @dialpad/dialtone-icons@vue3
21
17
  ```
22
18
 
23
- ### Lints and fixes files
19
+ Once installed, you can import icons like:
24
20
  ```
25
- npm run lint
21
+ import { Accessibility } from '@dialpad/dialtone-icons';
26
22
  ```
27
23
 
28
- ### Customize configuration
29
- See [Configuration Reference](https://cli.vuejs.org/config/).
24
+ ## Releasing
25
+
26
+ If you need to add icons, follow the next steps to get your icons published.
27
+
28
+ 1. Place the `.svg` files into `src/svg` folder.
29
+ 2. Commit your changes.
30
+ 3. Update the version on [package file](./package.json).
31
+ 4. Run `npm install`
32
+ 5. Commit the `package.json and package-lock.json` changes with message: 'chore: release ${version}'
33
+ 6. Push your changes.
34
+ 7. Run `npm run release`
35
+
36
+ ## Questions?
37
+
38
+ If you have a question, please feel free to [open an issue](https://github.com/dialpad/dialtone-icons/issues/new).