Update readme and add keywords

pull/411/head 2.0.4
cagataycivici 2020-07-23 11:58:18 +03:00
parent 0d1eb5a51e
commit 7a968e120f
2 changed files with 14 additions and 82 deletions

View File

@ -2,86 +2,8 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![npm version](https://badge.fury.io/js/primevue.svg)](https://badge.fury.io/js/primevue) [![npm version](https://badge.fury.io/js/primevue.svg)](https://badge.fury.io/js/primevue)
[![PrimeVue Hero](https://i2.wp.com/www.primefaces.org/wp-content/uploads/2020/05/experimental-1-1.jpg?resize=1060%2C596&ssl=1 "PrimeVue Hero")](https://www.primefaces.org/primevue) [![PrimeVue Hero](https://i0.wp.com/www.primefaces.org/wp-content/uploads/2020/07/primevue-release-20-opt.jpg?resize=1060%2C795&ssl=1)](https://www.primefaces.org/primevue)
# PrimeVue ### Website
[![PrimeVue Logo](https://www.primefaces.org/wp-content/uploads/2019/05/primevue-logo-200.png "PrimeVue")](https://www.primefaces.org/primevue) Visit the [PrimeVue Website](https://www.primefaces.org/primevue/) for general information, demos and documentation.
PrimeVue is available at npm, if you have an existing application run the following commands to download PrimeVue and PrimeIcons to your project.
```js
npm install primevue --save
npm install primeicons --save
```
### Module Loader
This is the recommended way if your application uses [vue-cli](https://cli.vuejs.org/) or has a webpack based build with [vue-loader](https://github.com/vuejs/vue-loader) configured. Import the components as .vue files for seamless integration within your project where path of each component is available at the "import" section of a component documentation.
```js
//import {ComponentName} from 'primevue/{componentname}';
import Dialog from 'primevue/dialog';
```
In the next step, register the component with the tag name you'd like to use.
```js
Vue.component('Dialog', Dialog);
```
Then you'll be able to utilize the component in your application.
```html
<Dialog></Dialog>
```
### Script Tag
Other alternative is utilizing the components directly within the browser with UMD packages.
```html
<meta charset="utf-8">
<title>calendar demo</title>
<script src="https://unpkg.com/vue"></script>
<script src="https://unpkg.com/primevue/components/calendar/calendar.umd.js"></script>
<div id="app">
<p-calendar></p-calendar>
</div>
<script>
new Vue({
components: {
'p-calendar': calendar
}
}).$mount('#app')
</script>
```
### Dependencies
Majority of PrimeVue components (95%) are native and there are some exceptions having 3rd party dependencies such as Quill for Editor.
In addition, components require PrimeIcons library for icons.
```js
dependencies: {
"vue": "^2.6.10",
"primeicons": "^2.0.0"
}
```
Here is the list of components with 3rd party dependencies.
Component | Dependency
--- | ---
Charts | Charts.js 2.1.x+
Editor | Quill.js 1.3.3+
FullCalendar | FullCalendar 4.0.2+
PrimeFlex | DataView
### Styles
The css dependencies are as follows, note that you may change the theme with another one of your choice. If you are using a bundler such as webpack with a css loader you may import them to your main application component.
```javascript
primevue/resources/themes/saga-blue/theme.css //theme
primevue/resources/primevue.min.css //core css
primeicons/primeicons.css //icons
```
### Quickstart
An example application based on vue-cli is available at [GitHub](https://github.com/primefaces/primevue-quickstart).

View File

@ -1,6 +1,6 @@
{ {
"name": "primevue", "name": "primevue",
"version": "2.0.4-SNAPSHOT", "version": "2.0.4",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/primefaces/primevue.git" "url": "https://github.com/primefaces/primevue.git"
@ -15,6 +15,16 @@
"lint": "vue-cli-service lint", "lint": "vue-cli-service lint",
"test:unit": "vue-cli-service test:unit" "test:unit": "vue-cli-service test:unit"
}, },
"keywords": [
"primevue",
"vue",
"ui framework",
"component framework",
"ui library",
"component library",
"material",
"bootstrap"
],
"devDependencies": { "devDependencies": {
"core-js": "^2.6.5", "core-js": "^2.6.5",
"vue": "^2.6.10", "vue": "^2.6.10",