diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 3f20f641..cece8fa5 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,9 +1,11 @@ # Contributor Covenant Code of Conduct ## Our Pledge + In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. ## Our Standards + Examples of behavior that contributes to creating a positive environment include: - Using welcoming and inclusive language @@ -21,19 +23,23 @@ Examples of unacceptable behavior by participants include: - Other conduct which could reasonably be considered inappropriate in a professional setting ## Our Responsibilities + Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. ## Scope + This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. ## Enforcement + Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at markus.oberlehner@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. ## Attribution + This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] [homepage]: http://contributor-covenant.org diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5f26aa56..ac7176d0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,7 @@ # Contributing ## Reporting Issues + Found a problem? Want a new feature? - See if your issue or idea has [already been reported]. @@ -9,6 +10,7 @@ Found a problem? Want a new feature? Remember, a bug is a *demonstrable problem* caused by *our* code. ## Submitting Pull Requests + Pull requests are the greatest contributions, so be sure they are focused in scope, and do avoid unrelated commits. 1. To begin, [fork this project], clone your fork, and add our upstream. diff --git a/README.md b/README.md index edaa9f6b..97d1842c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # vuex-map-fields + [![Patreon](https://img.shields.io/badge/patreon-donate-blue.svg)](https://www.patreon.com/maoberlehner) [![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://paypal.me/maoberlehner) [![Build Status](https://travis-ci.org/maoberlehner/vuex-map-fields.svg?branch=master)](https://travis-ci.org/maoberlehner/vuex-map-fields) @@ -8,14 +9,17 @@ Enable two-way data binding for form fields saved in a Vuex store. ## Install + ```bash npm install --save vuex-map-fields ``` ### Basic example + The following example component shows the most basic usage, for mapping fields to the Vuex store using two-way data binding with `v-model`, without directly modifying the store itself, but using getter and setter functions internally (as it is described in the official Vuex documentation: [Two-way Computed Property](https://vuex.vuejs.org/en/forms.html#two-way-computed-property)). #### Store + ```js import Vue from 'vue'; import Vuex from 'vuex'; @@ -45,6 +49,7 @@ export default new Vuex.Store({ ``` #### Component + ```html