Skip to content

Commit 1ec9ea4

Browse files
committed
Add readme, license and git url in package.json
1 parent 9a8175c commit 1ec9ea4

3 files changed

Lines changed: 61 additions & 0 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2019 Felipe Guizar Diaz
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Ara Framework CLI
2+
3+
> Scaffolding tool for Ara Framework
4+
5+
## Installation
6+
7+
You can install the package from npm.
8+
9+
```bash
10+
npm i -g ara-cli
11+
```
12+
13+
##Usage
14+
15+
### Create Ara Project
16+
17+
```bash
18+
ara new:project ara-demo
19+
```
20+
21+
### Create Nova Microfrontend
22+
23+
```bash
24+
ara new:nova
25+
```
26+
27+
By default the scaffolding for nova uses a Vue.js template but you can use more passing the flah `-t, --template`
28+
29+
```bash
30+
ara new:nova -t angular
31+
```

package.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22
"name": "ara-cli",
33
"version": "0.1.0",
44
"description": "Ara Framework Command Line Interface",
5+
"keywords": [
6+
"ara",
7+
"cli"
8+
],
9+
"author": "Felipe Guizar Diaz <felipegaiacharly@gmail.com>",
10+
"repository": {
11+
"type": "git",
12+
"url": "git+https://github.com/ara-framework/ara-cli.git"
13+
},
514
"main": "src/index.js",
615
"bin": {
716
"ara": "src/index.js"

0 commit comments

Comments
 (0)