diff --git a/README.md b/README.md index 58156ec4..08f4a982 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,25 @@ [![Build Status](https://travis-ci.org/ngx-builders/netlify-builder.svg?branch=master)](https://travis-ci.org/nitishk72/netlify-builder) [![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors) + +## **Deploy your Angular app to Netlify directly from the Angular CLI! 🚀** +### Pre-requisites +- Angular project created via [Angular CLI](https://github.com/angular/angular-cli) v8.3.0 or greater. + +### Steps: +1. run ```ng add @netlify-builder/deploy``` to add necessary dependencies. Once, it get installed,you will be prompted to enter (a) Site Id and (b) netlfy Token + ![Screenshot](screenshots/step-1.png) +2. run ```ng deploy``` assuming that you have [Angular CLI](https://github.com/angular/angular-cli) installed globally + + OR + + add below script to ```package.json``` + ``` + "deploy":"ng deploy" + ``` + + ![Screenshot](screenshots/step-2.png) + + # Netlify Builder demo diff --git a/screenshots/step-1.png b/screenshots/step-1.png new file mode 100644 index 00000000..b8da0423 Binary files /dev/null and b/screenshots/step-1.png differ diff --git a/screenshots/step-2.png b/screenshots/step-2.png new file mode 100644 index 00000000..a27a31ca Binary files /dev/null and b/screenshots/step-2.png differ