[readme] [l]: add readme and screencast

This commit is contained in:
Thadeu Cotts 2020-11-26 17:12:05 -03:00
parent 80974254fe
commit 21082f9f6a
2 changed files with 29 additions and 0 deletions

View File

@ -0,0 +1,29 @@
# Create Portal App
<br/>
<img src="resources/create-portal-app.gif">
<br/>
<br/>
This is a friendly way to start using `portal.js`. Using this CLI helps you to set up fast and easly one portal.js with the default template.
The CLI automatically create the project folder, install main dependencies, generate a new git repository and change package name.
<br/>
## How to use
To create a new portal.js application you can send the project name as first argument.
```
create-portal-app my-app
```
<br/>
## Options
`create-portal-app` comes with options:
- **--use-npm** - This option allows to use npm instead yarn as default package manager

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB