Skip to content

Commit

Permalink
Add contributing section
Browse files Browse the repository at this point in the history
  • Loading branch information
DannyFeliz committed Nov 5, 2019
1 parent 5efe95b commit 06fba0a
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 3 deletions.
70 changes: 69 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
# vue-email-dropdown

> A Vue component for autocomplete email domains
> [<img src="https://img.shields.io/npm/dt/vue-email-dropdown.svg">](https://www.npmjs.com/package/vue-email-dropdown) > [<img src="https://img.shields.io/npm/v/vue-email-dropdown.svg">](https://www.npmjs.com/package/vue-email-dropdown)
# Demo

[![Edit Demo vue-email-dropdown](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/vue-template-lrkul?fontsize=14)

![Demo](https://raw.githubusercontent.com/DannyFeliz/vue-email-dropdown/master/demo/demo.gif)

# Props
Expand Down Expand Up @@ -48,7 +54,61 @@
</tbody>
</table>

## Project setup
## Installation

```bash
npm install vue-email-dropdown --save

# or with yarn

yarn global add vue-email-dropdown
```

## Usage

```vue
<template>
<EmailDropdown :domains="domains" :defaultDomains="defaultDomains" />
</template>
<script>
// Import package
import EmailDropdown from "vue-email-dropdown";
// Import basic styles (optional)
import "vue-email-dropdown/dist/vue-email-dropdown.css";
import EmailDropdown from "vue-email-dropdown";
export default {
components: {
EmailDropdown
},
data() {
return {
domains: [
"yourcompany.com",
"gmx.de",
"googlemail.com",
"hotmail.fr",
"hotmail.it",
"web.de",
"yahoo.co.in",
"yahoo.com",
"yahoo.in"
],
defaultDomains: [
"gmail.com",
"hotmail.com",
"msn.com",
"outlook.com",
"yahoo.com"
]
};
}
};
</script>
```

## Development setup

```
npm install
Expand Down Expand Up @@ -81,3 +141,11 @@ npm run lint
### Customize configuration

See [Configuration Reference](https://cli.vuejs.org/config/).

# Contributing

1. Fork it (<https://github.com/dannyfeliz/vue-email-dropdown/fork>)
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
{
"name": "vue-email-dropdown",
"version": "1.0.1",
"version": "1.0.2",
"main": "./dist/vue-email-dropdown.umd.min.js",
"files": [
"dist/vue-email-dropdown.umd.min.js"
"dist/vue-email-dropdown.umd.min.js",
"dist/vue-email-dropdown.css"
],
"keywords": [
"vue",
Expand Down

0 comments on commit 06fba0a

Please sign in to comment.