diff --git a/packages/create-portal-app/README.md b/packages/create-portal-app/README.md new file mode 100644 index 00000000..455171df --- /dev/null +++ b/packages/create-portal-app/README.md @@ -0,0 +1,29 @@ +# Create Portal App + +
+ + + +
+
+ +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. + +
+ +## How to use + +To create a new portal.js application you can send the project name as first argument. +``` +create-portal-app my-app +``` + +
+ +## Options +`create-portal-app` comes with options: + +- **--use-npm** - This option allows to use npm instead yarn as default package manager + + diff --git a/packages/create-portal-app/resources/create-portal-app.gif b/packages/create-portal-app/resources/create-portal-app.gif new file mode 100644 index 00000000..cb2c3a4a Binary files /dev/null and b/packages/create-portal-app/resources/create-portal-app.gif differ