chore(docs): update introduction page

wintercounter · Jan 22, 2019 · bc1cf9d · bc1cf9d
1 parent 730ad8b
commit bc1cf9d
Show file tree

Hide file tree

Showing 2 changed files with 88 additions and 67 deletions.
diff --git a/README.md b/README.md
@@ -1,54 +1,65 @@
-![](docs/.gitbook/assets/logo-2.png)
+# Documentation
+[https://mhy.js.org](https://mhy.js.org)
 
 # `mhy`?
 
-> Out-of-the box development environment.
+>  An _out-of-the_ box **multi-purpose** toolbox and development environment.
 
-`mhy` \(my\) is supposed to be a development/production environment/compiler/ecosystem _out-of-the_ box. I just simply had enough of having multiple instances of the same npm packages on my machine, and the need to setup a development environment each time I start a new project.
+It's really hard to define what `mhy` \(my\) is, because it tries to create a unified developer experience for any stage of your project:
+* a pre-configured **development environment** to not waste time with the set-up when starting a new project or just need a quick playground.
+* a pre-configured **production environment** to help you reach production faster compiling/building your code without any necessary setup.
+* an **ecosystem** to be able to run different task together at once, connected together perfectly.
+* a **toolbox** help your work with the most common tasks.
+* a **solution for littering** your machine with the same npm package over and over again.
+* a **config management** tool make necessary changes faster at a single place.
+* an **interoperable environment** to be shared across multiple projects and ensure they are being build on the same principles/stack.
 
-I hate the need to configure a bunch of configs/scripts, the need to open up multiple terminals and start commands separately. I hate that I always have to align different configs to be able to start development \(like Babel for Webpack, Jest and Storybook\).
+> `mhy` helps you to be able to focus on your code again rather then the tech behind it.
 
-This is `mhy` own development environment, how I like it and/or want it to be, instantly, anywhere, simply.
+## Using `mhy` you'll have
 
-# Documentation
-[https://mhy.js.org](https://mhy.js.org)
+* a **Zero-configuration** environment **out-of-the-box**.
+* a **portable** codebase without any `npm install`.
+* **simple customization** if you don't favor the default settings.
+* **package.json based customization** for any configs value `mhy` provides.
+* **boot templates** for easy setup.
+* **most common packages** provided to your work.
+* a **single command TUI** to run a full ecosystem.
+* **less boilerplate**.
+* configs/tools **well-playing** together _(webpack+babel, jest+babel, storybook+webpack, webpack+typescript, etc.)_.
+* **pre-built and public Docker images** for faster CI.
 
-# A tool for simple
+> Note that `mhy`'s focus is on client side currently, but server side features are about to come.
 
-* app/site development
-* package/library development
-* build process setup
-* project initialization
-* interoperability
-* configuration building
+## Quick-start examples
 
-# Quickstart
+## Install `mhy` globally
 ```bash
 npm install mhy -g
+```
+
+### Start a new project serving with `webpack-dev-server` configured for Babel and React
+```bash
 mkdir src
 echo "console.log('Hello mhy!')" > src/index.js
 mhy wds
 ```
 
-# Problems trying to solve
-
-* Zero-configuration
-* Out-of-the box
-* Portability
-* Simple customization
-* Using package.json for any config options
-* Boot templates for easy starts
-* Package hell: No more multiple installs on the same machine
-* Single command and UI to run all necessary process
-* Less boilerplate
-* Shared configs across different tools
-* Faster deployments using pre-built and public docker images
-* Providing common/popular/standard packages
-* Up-to-date policy
-
-# Supported tools
-
-`mhy` is providing many common/popular packages out-of the box. There are continuous adjustments being made to the includes to match the most common needs and being able to develop without the need of your own `npm install` command ever again. The best is to check the dependencies of our `package.json` for the included packages, and I also advice you to check out our sources for more details.
+### Compile codebase as a library for production use
+```bash
+mhy babel --mhy-prod
+```
+
+### Start the default ecosystem in a single terminal (Jest, Webpack Dev Server, TypeScript compiler, Storybook)
+```bash
+mhy
+```
+
+> Form the `src` folder it creates a complied `dist` folder.
+
+## Supported packages
+
+`mhy` is providing many common/popular packages. There are continuous adjustments being made to the includes to match the most common needs and being able to develop without the need of your own `npm install` command ever again. It's in plan to accurately list these on the site, for now the best is to check the dependencies of our `package.json` for the included packages, and I also advice you to check out our sources for more details.
 
 ## Contributors
 

diff --git a/docs/README.md b/docs/README.md
@@ -1,54 +1,64 @@
 # Introduction
 
-![](.gitbook/assets/logo-2%20%281%29.png)
-
 ## `mhy`?
 
-> Out-of-the box development environment.
+>  An _out-of-the_ box **multi-purpose** toolbox and development environment.
 
-`mhy` \(my\) is supposed to be a development/production environment/compiler/ecosystem _out-of-the_ box. I just simply had enough of having multiple instances of the same npm packages on my machine, and the need to setup a development environment each time I start a new project.
+It's really hard to define what `mhy` \(my\) is, because it tries to create a unified developer experience for any stage of your project:
+* a pre-configured **development environment** to not waste time with the set-up when starting a new project or just need a quick playground.
+* a pre-configured **production environment** to help you reach production faster compiling/building your code without any necessary setup.
+* an **ecosystem** to be able to run different task together at once, connected together perfectly.
+* a **toolbox** help your work with the most common tasks.
+* a **solution for littering** your machine with the same npm package over and over again.
+* a **config management** tool make necessary changes faster at a single place.
+* an **interoperable environment** to be shared across multiple projects and ensure they are being build on the same principles/stack.
 
-I hate the need to configure a bunch of configs/scripts, the need to open up multiple terminals and start commands separately. I hate that I always have to align different configs to be able to start development \(like Babel for Webpack, Jest and Storybook\).
+> `mhy` helps you to be able to focus on your code again rather then the tech behind it.
 
-This is `mhy` own development environment, how I like it and/or want it to be, instantly, anywhere, simply.
+## Using `mhy` you'll have
 
-## A tool for simple
+* a **Zero-configuration** environment **out-of-the-box**.
+* a **portable** codebase without any `npm install`.
+* **simple customization** if you don't favor the default settings.
+* **package.json based customization** for any configs value `mhy` provides.
+* **boot templates** for easy setup.
+* **most common packages** provided to your work.
+* a **single command TUI** to run a full ecosystem.
+* **less boilerplate**.
+* configs/tools **well-playing** together _(webpack+babel, jest+babel, storybook+webpack, webpack+typescript, etc.)_.
+* **pre-built and public Docker images** for faster CI.
 
-* app/site development
-* package/library development
-* build process setup
-* project initialization
-* interoperability
-* configuration building
+> Note that `mhy`'s focus is on client side currently, but server side features are about to come.
 
-## Quickstart
+## Quick-start examples
 
+## Install `mhy` globally
 ```bash
 npm install mhy -g
+```
+
+### Start a new project serving with `webpack-dev-server` configured for Babel and React
+```bash
 mkdir src
 echo "console.log('Hello mhy!')" > src/index.js
 mhy wds
 ```
 
-## Problems trying to solve
-
-* Zero-configuration
-* Out-of-the box
-* Portability
-* Simple customization
-* Using package.json for any config options
-* Boot templates for easy starts
-* Package hell: No more multiple installs on the same machine
-* Single command and UI to run all necessary process
-* Less boilerplate
-* Shared configs across different tools
-* Faster deployments using pre-built and public docker images
-* Providing common/popular/standard packages
-* Up-to-date policy
-
-## Supported tools
-
-`mhy` is providing many common/popular packages out-of the box. There are continuous adjustments being made to the includes to match the most common needs and being able to develop without the need of your own `npm install` command ever again. The best is to check the dependencies of our `package.json` for the included packages, and I also advice you to check out our sources for more details.
+### Compile codebase as a library for production use
+```bash
+mhy babel --mhy-prod
+```
+
+### Start the default ecosystem in a single terminal (Jest, Webpack Dev Server, TypeScript compiler, Storybook)
+```bash
+mhy
+```
+
+> Form the `src` folder it creates a complied `dist` folder.
+
+## Supported packages
+
+`mhy` is providing many common/popular packages. There are continuous adjustments being made to the includes to match the most common needs and being able to develop without the need of your own `npm install` command ever again. It's in plan to accurately list these on the site, for now the best is to check the dependencies of our `package.json` for the included packages, and I also advice you to check out our sources for more details.
 
 ## Contributors