Documentation alpha 01 (#12)

refactor(docs): Add file base add core team and getting started items to README.md add new docs files pre requisites remove old docs files getting started progress working with plugins progress add 80% of getting started remove old folder Add a more comprehensive explanation on the home Readme.… (#13) Add a more comprehensive explanation on the home Readme.md. And to more directly send people to either the getting started OR to the full documentation.
scullyio · Dec 15, 2019 · f98b4b2 · f98b4b2
1 parent e0bc785
commit f98b4b2
Show file tree

Hide file tree

Showing 14 changed files with 227 additions and 259 deletions.
diff --git a/Documentation/demosteps.md b/Documentation/demosteps.md
diff --git a/Documentation/genration steps.md b/Documentation/genration steps.md
diff --git a/Documentation/gettingStarted.md b/Documentation/gettingStarted.md
diff --git a/Documentation/pupeteer_vs_universal.md b/Documentation/pupeteer_vs_universal.md
diff --git a/Documentation/schematics.md b/Documentation/schematics.md
diff --git a/README.md b/README.md
@@ -2,20 +2,49 @@
 
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 
+The best way to build the fastest Angular apps. Scully is a static site generator for Angular projects looking to embrace the JAMStack.
 
-A static site generator for Angular-CLI projects.
+- [Getting Started](docs/getting-started.md)
+- [Full Documentation](docs/scully.md)
 
-This is the initial setup.
+# What is Scully?
+Scully pre-renders each page in your app to plain HTML & CSS. To do this, Scully uses machine learning techniques to find 
+all of the routes in your project. Scully then visits each route, rendering the view and saving it to an HTML file.
 
+You can then ship all of those HTML files to production. Each view in your app can now be delivered to your users in just 
+a few KBs, as opposed to the hundreds/thousands of KBs require to download your entire Angular app. 
 
+Your app appears INSTANTLY on any device (including mobile 3G). 
 
+Once the fully-rendered HTML arrives/appears on the user's view, your Angular app will them load and bootstrap ontop of
+the existing view. This means that Scully gives you the best of both worlds:
 
-#### created by 
-![logo](assets/logo-400x400.jpg)
+1. The ability to pre-render your entire app to the most base form of HTML & CSS. 
+2. The ability to still have a full powered SPA written in Angular. 
 
+When your app is pre-rendered, users no longer wait until all the JavaScript has downloaded, parsed and executed before 
+they can see and interact with your website. They can immediately begin to see and interact with the page. When your page
+is IMMEDIATELY available, you will have less abandoned sessions and a much higher conversion rate on our website. 
 
+This also means that may not need to ship your backend to production. Because the view is pre-rendered and the
+data is fetched at build time, all views that can run without the backend in prod CAN run without the backend in prod. 
+The security an cost implications to that fact can be mind blowing when you think about them. 
 
+For those wanting to know more about this process, please read the [Getting Started](docs/getting-started.md) guide. For
+those who want to know more about the theory behind pre-rendering JavaScript SPAs, our friends at [Netlify](https://netlify.com)
+wrote a [free book about the JAMStack](https://www.netlify.com/pdf/oreilly-modern-web-development-on-the-jamstack.pdf). 
+Check that out today. 
 
-## bazel things
+## Core Team
+
+| Aaron Frost                                                               | Sander Elias                                                                | Jorge Cano                                                                  | Andres Villanueva                                                                |
+| ------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------|
+| ![Aaron Frost](https://avatars0.githubusercontent.com/u/662832?s=120&v=4&1) | ![Sander Elias](https://avatars3.githubusercontent.com/u/1249083?s=120&v=4) | ![Jorge Cano](https://avatars3.githubusercontent.com/u/5982204?s=120&v=4)   | ![Andres Villanueva](https://avatars0.githubusercontent.com/u/1209238?s=120&v=4) |
+| [aaronfrost](https://github.com/aaronfrost)                               | [SanderElias](https://github.com/SanderElias)                               | [jorgeucano](https://github.com/jorgeucano)                                 | [villanuevand](https://github.com/villanuevand)                                  |
+
+
+#### Created by 
+![logo Hero Devs](assets/hero-devs-logo-80x80.jpg)
+
+***HeroDevs. LLC***
 
-All with ibazel is watch mode, the same without the i is no-watch
diff --git a/assets/logo-400x400.jpg → assets/hero-devs-logo-400x400.jpg b/assets/logo-400x400.jpg → assets/hero-devs-logo-400x400.jpg
diff --git a/assets/hero-devs-logo-80x80.jpg b/assets/hero-devs-logo-80x80.jpg