Skip to content

Commit

Permalink
Add release instructions, reference to codepen sandbox, and CDN insta…
Browse files Browse the repository at this point in the history
…llation instructions
  • Loading branch information
rjcorwin committed Aug 5, 2019
1 parent c2dd7b8 commit 34a9f60
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ An element for multipage forms.
- Loads of handy input elements such as `<tangy-gps>`.
- Easy to write logic for the form for hiding / showing and disabling / enabled inputs.

Play with the [demo on glitch](https://tangy-form-demo.glitch.me/).
Try out the [demos on glitch](https://tangy-form-demo.glitch.me/) or get started creating your own Tangy Form on [CodePen](https://codepen.io/rjsteinert/pen/RXxwmP).

![screenshot](demo/screenshot.png)
[![screenshot](demo/screenshot.png)](https://codepen.io/rjsteinert/pen/RXxwmP)


<!--
Expand Down Expand Up @@ -57,6 +57,16 @@ You can re-enable the form by using disableItemReadOnly() (and showItemButtons()
## Installation
`<tangy-form>` is a Custom Element built with Polymer and can be used in frameworks such as Angular, React, and Vue. Check compatibility with your project's framework on [Custom Elements Everywhere](https://custom-elements-everywhere.com/). If you are ready to go, run `npm install --save tangy-form` to add it to your project. Depending on your build system/framework, there may be different steps to take to get Web Components loading.

### Install using the CDN
A quick and easy way to get started with Tangy Form in your app is to add the necessary script tags to import dependencies from CDNs. The following should be all you need to get started.

```
<script src="https://cdnjs.cloudflare.com/ajax/libs/webcomponentsjs/2.2.10/webcomponents-loader.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/redux/4.0.4/redux.js"></script>
<script src="https://unpkg.com/[email protected]/dist/bundle.js" type="module"></script>
```


### Install in a Polymer v3 project
```
npm install --save tangy-form
Expand Down
10 changes: 10 additions & 0 deletions RELEASE-INSTRUCTIONS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Instruction for releasing a new version of Tangy Form

1. Increment the version number in `package.json`.
2. Create an and fill out an entry in `CHANGELOG.md` for the release.
3. Run `npm run build`.
4. Git add the `dist` folder, `package.json`, and `CHANGELOG.md`.
5. Git commit with a git commit message of the same release number.
6. Git tag with the same name as the release number.
7. Git push the master branch, git push the tag.
8. Ensure you have a clean directory with a `git status` then run `npm publish`.

0 comments on commit 34a9f60

Please sign in to comment.