diff --git a/README.md b/README.md
index 40b790e..03693d2 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,10 @@
-# Airframe
+# Airframe React
High Quality **Dashboard / Admin / Analytics template** that works great on any smartphone, tablet or desktop. Available as **Open Source as MIT license.**
- [View Demo](http://dashboards.webkom.co/jquery/airframe)
-- [React Version](http://dashboards.webkom.co/react/airframe/)
+- [View Demo](http://dashboards.webkom.co/react/airframe/)
+- [jQuery Version](http://dashboards.webkom.co/jquery/airframe)
- [Next Version](http://airframe.nextjs.webkom.co) - _Documentation in preparation_
- [Angular Version](http://dashboards.webkom.co/angular/airframe) - _Documentation in preparation_
- [Vue Version](http://dashboards.webkom.co/vue/airframe) - _Documentation in preparation_
@@ -16,7 +17,7 @@ High Quality **Dashboard / Admin / Analytics template** that works great on any
**Airframe Dashboard** with a minimalist design and innovative Light UI will let you build an amazing and powerful application with great UI. Perfectly designed for large scale applications, with detailed step by step documentation.
-This **Airframe version** is a standard HTML template using **jQuery** and **Bootstrap 4**. Most of the layouting and components you are able to find in the [Official Bootstrap Documentation](http://getbootstrap.com).
+This **Airframe** project is a typical Webpack based React app, [React Router](https://reacttraining.com/react-router/web/guides/quick-start) also included together with customised [Reacstrap](https://reactstrap.github.io). This project has all of it's few dependencies up to date and it will be updated on a regular basis. This project doesn't support SSR. If you need it - use the [NextJs](https://github.com/zeit/next.js/) based version.
# Features
@@ -40,189 +41,161 @@ This **Airframe version** is a standard HTML template using **jQuery** and **Boo
# Installation
-## Additional Components
-This Dashboard has some additional classes and JS components to achieve the final effect.
+## Initial Configuration:
+You need to have [NodeJs](https://nodejs.org/en/) (>= 10.0.0) installed on your local machine, before attempting to run a dev environment.
-### Layout
-This component will keep the whole layout in place it should look like this.
-```html
-
-
-
-
-
-
-
+ { /* ... */ }
+
+ );
+}
```
-The layout component also supports **theming** you can add a specific class related to a particular theme which will add a color scheme to the whole layout (mainly sidebar and targeted navbars). Classes which are providing this feature have this format: `layout--theme--
--`. Here are the possible values for `theme-style` and `theme-color`:
+#### Dynamic Imports
+Dynamically imported pages will only be loaded when they are needed. This will decrease the size of the initial page load and make the App load faster. You can use `React.Suspense` to achieve this. Example:
+```jsx
+// Create a Lazy Loaded Page Component Import
+const SomeAsyncPage = React.lazy(() => import('./SomeAsyncPage'));
+// ...
+export const RoutedContent = () => {
+ return (
+
+ { /* ... */ }
+ { /*
+ Define the route and wrap the component in a React.Suspense loader.
+ The fallback prop might contain a component which will be displayed
+ when the page is loading.
+ */ }
+
+ }>
+
+
+
+
+ );
+}
+```
+#### Route specific Navbars and Sidebars
+Sometimes you might want to display additional content in the Navbar or the Sidebar. To do this you should define a customized Navbar/Sidebar component and attach it to a particular route. Example:
-**theme-style**
-* `light`
-* `dark`
-* `color`
+```jsx
+import { SidebarAlternative } from './../layout/SidebarAlternative';
+import { NavbarAlternative } from './../layout/NavbarAlternative';
+// ...
+export const RoutedNavbars = () => (
+
+ { /* Other Navbars: */}
+
+ { /* Default Navbar: */}
+
+
+);
-**theme-color**
-* `primary`
-* `success`
-* `info`
-* `warning`
-* `danger`
-* `indigo`
-* `purple`
-* `pink`
-* `yellow`
-
-### Sidebar
-Sidebar can contain a navigation menu and addtional information. Everything is organized in sections. It can be in a Slim state on larger displays, and collapsible on small screens. Example Sidebar:
-```html
-
+export const RoutedSidebars = () => (
+
+ { /* Other Sidebars: */}
+
+ { /* Default Sidebar: */}
+
+
+);
```
-**Notable classes**
-* `sidebar--animations--enabled` - will make the sidebar animated in most of the interactions
-* `sidebar--slim` - will allow the sidebar to be slim when collapsed on desktop
-* `sidebar--collapse` - will hide the sidebar, or make it slim if defined so
-* `sidebar__mobile-fluid` - all of the contents of that element will be scrollable on mobile sidebar
-* `sidebar__section` - building block of the sidebar
-* `sidebar__section--fluid` - section which will fill all available height of the sidebar
-* `sidebar__section--cover` - removes the section padding
-* `sidebar__hide-slim` - __(helper)__ hides an element when the sidebar goes into slim mode
-* `sidebar__show-slim` - __(helper)__ shows an element when the sidebar goes into slim mode
+## Theming
+You can set the color scheme for the sidebar and navbar by providing `initialStyle` and `initialColor` to the `` component which should be wrapping the `` component.
-### Sidebar Menu
-Provides navigation for the sidebar. Allows for multilevel nesting, may be in a slim form with dropdowns. Has to be placed in a fluid, covered section. Example Sidebar Menu:
-```html
-
```
-* `sidebar-menu` - parent of the menu
-* `sidebar-menu--slim` - should be present when the sidebar is in slim collapsed mode
-* `sidebar-menu__entry` - contains the 0 level link
-* `sidebar-menu__entry--nested` - contains the 0 level nested links
-* `sidebar-menu__entry--no-caret` - removes the caret which is added by nested entries
-* `sidebar-menu__link` - level 0 link
-* `sidebar-menu__entry__icon` - icon representing a particular entry
-* `sidebar-submenu` - contains the nested entries
-* `sidebar-submenu__entry` - contains the nth level link
-* `sidebar-submenu__entry--nested` - contains the nth level nested links
-* `sidebar-submenu__entry__link` - nth level link
-### Navbars
-Navbars are essentially Bootstraps navbars, but there are some additional classes which extend their behavior.
-* `navbar-themed` - will receive the theme colors from the layout theme class
-* `navbar-shadow` - will add a shadow at the bottom of the navbar
-* `navbar-multi-collapse` - allows to make the navbar collapse, not collapse all of the items, the underling `container` should also have `navbar-collapse-wrap` class
-
-### Additional Helpers
-* `sidebar__brand` - will add a theme color to a brand text
-* `sidebar__link` - should be used on additional links in sidebar, will add proper themed colors
-* `sidebar__link--muted` - muted modifier for the sidebar link
-* `text-theme` - will set the text color to the current theme
-* `bg-theme` - will set the background color to the current theme
-
-## JavaScript
-You can add predefined script which will handle all of the sidebar behaviour: sidebar menu, sidebar collapsing, animations etc.
-
-```html
-
-
-
-
-
-
-
-
-
-
-
-
-
-```
+Options provided by the `ThemeConsumer`:
+* **style** - current theme style
+* **color** - current theme color
+* **onChangeTheme({ style?, color? })** - allows to change the theme
# Credits
Used plugins in this dashboard: