Skip to content

Commit 116c361

Browse files
Added license and basic readme
1 parent c0530a5 commit 116c361

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

license.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Copyright 2017 Ivan Mattie and Dominic Valenciana
2+
3+
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
4+
5+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

readme.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Custom Element CLI
2+
3+
This is a simple CLI tool that can quickly create Javascript templates for
4+
v1-spec custom elements.
5+
6+
## Installation
7+
8+
To install, simply run:
9+
10+
```CLI
11+
npm i -g create-element-cli
12+
```
13+
14+
## Creating an Element
15+
16+
To create an element, run the following:
17+
18+
```CLI
19+
create-element [element-name]
20+
```
21+
22+
This will create `[element-name].js` in the folder where the command was run,
23+
where `[element-name]` is the name of the literal element that you want to
24+
create.

0 commit comments

Comments
 (0)