Skip to content
This repository has been archived by the owner on Feb 27, 2022. It is now read-only.

Commit

Permalink
Add dev support (#5)
Browse files Browse the repository at this point in the history
* Add development instructions

* Update package version

Co-authored-by: Kendall Roth <kendall@focus21.io>
  • Loading branch information
kendallroth and Kendall Roth committed Sep 30, 2020
1 parent 0012eea commit 217676a
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 1 deletion.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased

## [0.2.3] - 2020-09-30
### Added
- Development instructions and guide

### Removed
- Removed duplicated `npm-test` step from publish Action

Expand Down
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ Simple Vue form state management library (no validation, etc).
- [`FormCreateMixin`](#formcreatemixin)
- [`FormLeaveGuardMixin`](#formleaveguardmixin)

```sh
npm install @kendallroth/vue-simple-forms --save
```

## Features

- Create reactive Vue data for forms
Expand Down Expand Up @@ -149,6 +153,23 @@ The `FormLeaveGuardMixin` provides a computed property to control a confirmation

> **NOTE:** Since these API names can be configured, use the appropriate names from the mixin constructor.
## Development

Plugin development can be aided by installing this package locally (through file path) in another project.

```sh
cd project-with-dependency

# Relative path depends on location from "depending" project
npm install ../vue-simple-forms
```

This project can be started and will automatically rebuild on file changes:

```sh
npm run build:dev
```

## Miscellaneous

> Project boilerplate from: [`flexdinesh/npm-module-boilerplate`](https://github.com/flexdinesh/npm-module-boilerplate)
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@kendallroth/vue-simple-forms",
"version": "0.2.2",
"version": "0.2.3",
"description": "Simple Vue form state management library",
"main": "./lib/index.js",
"scripts": {
Expand All @@ -13,6 +13,7 @@
"test:watch": "npm run test:only -- --watch",
"lint": "eslint src test",
"build": "cross-env BABEL_ENV=production babel src --out-dir lib",
"build:dev": "cross-env BABEL_ENV=development babel src --out-dir lib --watch",
"prepublish": "npm run clean && npm run test && npm run build"
},
"files": [
Expand Down

0 comments on commit 217676a

Please sign in to comment.