chore(release): 2.0.0 🎉🎉🎉

tarsisexistence · Jun 9, 2019 · af5770b · af5770b
1 parent 9fe8f90
commit af5770b
Show file tree

Hide file tree

Showing 23 changed files with 253 additions and 371 deletions.
diff --git a/docs/.gitbook/assets/icon_origin_225x225.png b/docs/.gitbook/assets/icon_origin_225x225.png
diff --git a/docs/README.md b/docs/README.md
@@ -1,20 +1,52 @@
 # Introduction
 
-⚙ **Routeshub** is a route management library and pattern that acts as _hub_ which brings more control,  stable and predictable interaction with application through declarative design
+![](.gitbook/assets/icon_origin_225x225.png)
 
-## What is it ❓
+**Routeshub** is a route management library and pattern for **Angular.** 
 
-⚙ Routeshub is a route management __library and pattern for standardized managing routes
+Acts as a hub, which brings more control, stable and predictable interaction with project code base through declarative design
 
-💡 Designed to improve tuning and handling developers routes business in the more comfortable way
+## What is it
+
+⚙ A route manager. Designed to improve improve reliability and speed of development
+
+🔩 Engineered by plugin design. It was designed to be added at any time during the development process, even for separate complicated project parts.
 
 🔧 Modeled after a tree data structure. 
 
-🔩 Engineered as a plugin for Angular
+## Support
+
+Originally it was invented for **@angular/router.**
+
+Support for other routing libraries is the goal**.**
+
+## **Contributing**
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+Please make sure to update tests as appropriate and keep the examples consistent.
+
+## **Changelog**
+
+Stay tuned with [changelog](https://github.com/maktarsis/routeshub/blob/master/CHANGELOG.md) on GitHub
+
+## Questions
+
+If you still have the questions or suggestions, then create an [issue](https://github.com/maktarsis/routeshub/issues)  or feel free to contact me on [twitter](https://twitter.com/maktarsis)
+
+## Looking for the best
+
+This project is neither ideal nor final.
+
+Just a step for the better. A step to help engineers building applications better and faster.
+
+That's why I'll be happy with any kind of involvement and I am opened to any suggestions.
 
-## For whom ❓
+{% hint style="info" %}
+**Essence**
 
-Originally it was invented and developed for those who work with **@angular/router**
+It is a slightly different concept from _state management._
 
-Support for other routing libraries is the goal
+Routeshub collects and analyzes routes information to create manageable state of route_._ You can understand this concept as a **hub**.
+{% endhint %}
 
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -1,23 +1,20 @@
 # Table of contents
 
 * [Introduction](README.md)
-* [Getting Started](getting-started/README.md)
-  * [Motivation](getting-started/motivation.md)
-  * [Installation](getting-started/installation.md)
+* [Installation](installation.md)
+* [Example](example/README.md)
+  * [Initial Code](example/initial-code.md)
+  * [Creating Hub](example/creating-hub.md)
+  * [Connecting the dots](example/connecting-the-dots.md)
+  * [Navigating](example/navigating.md)
 * [Concepts](concepts/README.md)
   * [Introduction](concepts/introduction.md)
-  * [Creators](concepts/creators.md)
   * [Notes](concepts/notes.md)
   * [Slices](concepts/slices.md)
+  * [Unions](concepts/unions.md)
 * [API](api/README.md)
   * [Interfaces](api/interfaces.md)
   * [Creators](api/creators.md)
   * [Directives](api/directives.md)
-  * [Other](api/other.md)
-* [Example](example/README.md)
-  * [Initial Code](example/initial-code.md)
-  * [Creating Notes](example/creating-notes.md)
-  * [Creating Slices](example/creating-slices.md)
-  * [Connecting the dots](example/connecting-the-dots.md)
-  * [Navigating](example/navigating.md)
+  * [Functions](api/functions.md)
 
diff --git a/docs/api/creators.md b/docs/api/creators.md
diff --git a/docs/api/directives.md b/docs/api/directives.md
diff --git a/docs/api/functions.md b/docs/api/functions.md
diff --git a/docs/api/interfaces.md b/docs/api/interfaces.md
diff --git a/docs/api/other.md b/docs/api/other.md
diff --git a/docs/concepts/creators.md b/docs/concepts/creators.md
diff --git a/docs/concepts/introduction.md b/docs/concepts/introduction.md
@@ -2,9 +2,7 @@
 
 There are a few concepts you need to know before start:
 
-* **Creators**
 * **Notes**
 * **Slices**
-
-These concepts describe the complete process of integration routeshub into application.
+* **Unions**
 
diff --git a/docs/concepts/notes.md b/docs/concepts/notes.md
diff --git a/docs/concepts/slices.md b/docs/concepts/slices.md
@@ -1,31 +1,44 @@
 # Slices
 
-Essentially, slice is an output. It just defines the enhanced route
+Slice is a modular entity that contains stateful module routes
 
-## Getting Know with Output
+**There are two ways to create the slice:**
 
-To create a slice we need :
+* createRoot
+* createFeature
 
-* parent's slice
-* current note
-* interface that describe a new feature slice
+**Root creator** _****_invokes only once to initialize the _hub_ in application. It takes initial \(app\) note and produces the slice which will be used for subsequent feature creators.
+
+In turn the **feature creator** is responsible for relations between parent and child nodes \(slices\).
+
+## Creating Root
+
+Usage example:
+
+```typescript
+import { createRoot } from 'routeshub';
+import { appNote, AppNote, routes } from './'
+
+export const appSlice: Slice<AppNote> = createRoot<AppNote>(appNote);
+```
+
+## Creating Feature
+
+Takes two arguments and two generic types \(the second is optional for children\). The first argument is a parent slice that links to this module. The second one is a note of the current module.
+
+Usage example:
 
 ```typescript
-// grabbing the feature creator and interface
-import { createFeature, Slice } from 'routeshub';
-// importing the parent slice
-import { appSlice } from 'app/routing/hub/app.slice';
-// importing module's notes and its interface
-import { aboutNotes, AboutRoutes } from './about.notes';
-
-// creating feature slice
-export const aboutSlice: Slice<AboutRoutes> = createFeature<AboutRoutes>(
+import { createFeature, createNote, Root, Slice } from 'routeshub';
+import { aboutNote, AboutNote, routes } from './';
+import { appSlice } from '../../../routing/hub';
+
+export const aboutSlice: Slice<AboutNote> = createFeature<AboutNote>(
   appSlice.about,
-  aboutNotes
+  aboutNote
 );
+
 ```
 
-{% hint style="success" %}
-That's it
-{% endhint %}
+As we noticed earlier,  **feature creator** needs the parent slice to connect it with with its note entity.
 
diff --git a/docs/concepts/unions.md b/docs/concepts/unions.md
@@ -0,0 +1,56 @@
+# Unions
+
+Union is an entity that connects several selected slices
+
+## Creating Union
+
+Takes one object as argument. Value is a slice, key - its name. Invalid name will flush an error to prevent mistakes in the future.
+
+```typescript
+import { createUnion } from 'routeshub';
+import { appSlice } from './hub/app.hub';
+import { aboutSlice } from '../views/about/hub';
+import { automobileSlice } from '../views/automobile/hub';
+import { bikeSlice } from '../views/bike/hub';
+import { bolidSlice } from '../views/bolid/hub';
+
+export const union = createUnion({
+  app: appSlice,
+  about: aboutSlice,
+  automobiles: automobileSlice,
+  bikes: bikeSlice,
+  bolids: bolidSlice
+});
+
+```
+
+It's ok, if you want to declare it only one time. Next time you want to use it you will need to access  it in the component.
+
+You can find unions useful because of their flexible design.
+
+{% code-tabs %}
+{% code-tabs-item title="header.component.ts" %}
+```typescript
+import { Component, OnInit } from '@angular/core';
+import { createUnion } from 'routeshub';
+import { appSlice as app } from '../../routing/hub/app.hub';
+import { authSlice as auth } from '../../auth/hub';
+
+@Component({
+  selector: 'app-header',
+  template: `  
+  <nav>
+    <a navLink="{{ union.app.root.state }}">Home</a>
+    <a [navLink]="union.auth.signUp.state">Sign Up</a>
+  </nav>
+`
+})
+export class HeaderComponent implements OnInit {
+  public union = createUnion({ app, auth });
+}
+```
+{% endcode-tabs-item %}
+{% endcode-tabs %}
+
+It doesn't perform long and complicated calculations. So, you are free to use it everywhere.
+
diff --git a/docs/example/connecting-the-dots.md b/docs/example/connecting-the-dots.md
diff --git a/docs/example/creating-hub.md b/docs/example/creating-hub.md
@@ -0,0 +1,100 @@
+# Creating Hub
+
+Let's create the notes and slices
+
+{% code-tabs %}
+{% code-tabs-item title="app.hub.ts" %}
+```typescript
+import { createRoot, createNote, Root, Note } from 'routeshub';
+import { routes } from './app.routes';
+
+export interface AppChildrenNote extends Root {
+  about: Note;
+}
+
+/**
+* Root is the shortcut of root path
+* Designed to speed up code reusing
+*/
+export interface AppNote extends Root<AppChildrenNote> {
+  auth: Note;
+  notFound: Note;
+}
+
+/**
+  * it is equivalent of the code above
+  * choose the one you comfortable with
+
+  export interface AppNotes {
+    root: Note<AppChildrenNote>
+    auth: Note;
+    notFound: Note;
+  }
+
+*/
+
+/**
+* you may be confused about the second argument
+* by default route path '' transforms into property 'root'
+* and '**' transforms into property 'wildcard'
+* 
+* So, you can customize property keys through the second argument
+* as illustrated below
+*/
+export const appNote = createNote<AppNote>(routes, { wildcard: 'notFound' });
+
+export const appSlice: Slice<AppNote, AppChildrenNote> = createRoot<
+  AppNote,
+  AppChildrenNote
+>(appNote);
+
+```
+{% endcode-tabs-item %}
+
+{% code-tabs-item title="about.hub.ts" %}
+```typescript
+import { createFeature, createNote, Root, Note } from 'routeshub';
+import { routes } from './about.routes';
+import { appSlice } from '../../../routing/app.hub';
+
+export type AboutNote = Root;
+
+export const aboutNote = createNote<AboutNote>(routes);
+
+export const aboutSlice: Slice<AboutNote> = createFeature<AboutNote>(
+  appSlice.about,
+  aboutNote
+);
+
+```
+{% endcode-tabs-item %}
+
+{% code-tabs-item title="auth.note.ts" %}
+```typescript
+import { createFeature, createNote, Root, Note } from 'routeshub';
+import { routes } from './auth.routes';
+import { appSlice } from '../../../routing/app.hub';
+
+export interface AuthNote extends Root {
+  signIn: Note;
+  signUp: Note;
+  id: Note;
+}
+
+export const authNote = createNote<AuthNote>(routes);
+
+export const authSlice: Slice<AuthNote> = createFeature<AuthNote>(
+  appSlice.auth,
+  authNote
+);
+
+```
+{% endcode-tabs-item %}
+{% endcode-tabs %}
+
+{% hint style="success" %}
+Setup
+{% endhint %}
+
+
+