Merge pull request #428 from topcoder-platform/PROD-3257_readme

PROD-3245 README & Version 1 -> PROD-3115_uni-nav

Author: brooketopcoder

src-ts/config/environments/environment.default.config.ts

@@ -42,6 +42,6 @@ export const EnvironmentConfigDefault: EnvironmentConfigModel = {
         WP_CONTENT: `${COMMUNITY_WEBSITE}/wp-content`,
     },
     UNIVERSAL_NAV: {
-        URL: 'https://uni-nav.topcoder-dev.com/tc-universal-nav.js',
+        URL: 'https://uni-nav.topcoder-dev.com/v1/tc-universal-nav.js',
     },
 }

src-ts/config/environments/environment.prod.config.ts

@@ -40,6 +40,6 @@ export const EnvironmentConfigProd: EnvironmentConfigModel = {
         WP_CONTENT: `${COMMUNITY_WEBSITE}/wp-content`,
     },
     UNIVERSAL_NAV: {
-        URL: 'https://uni-nav.topcoder.com/tc-universal-nav.js',
+        URL: 'https://uni-nav.topcoder.com/v1/tc-universal-nav.js',
     },
 }

src-ts/header/README.md

@@ -0,0 +1,28 @@
+# Topcoder Universal Navigation
+
+The Platform UI project uses the Topcoder Universal navigation ([README](https://github.com/topcoder-platform/universal-navigation)).
+
+## Uni-nav Versions
+
+The Uni-nav is a hosted JS library. There are currently dev and prod versions of the library located at:
+
+https://uni-nav.topcoder.com/v1/tc-universal-nav.js
+
+https://uni-nav.topcoder-dev.com/v1/tc-universal-nav.js
+
+The URL is set at build time with the [Global Config](../lib/global-config.model.ts) `UNIVERSAL_NAV.URL` property.
+
+>See the [Local Environment Setup](../../README.md#local-environment-setup) section of the main README for instructions on how to set your environment configuration.
+
+>See the [Uni-Nav Version README](https://github.com/topcoder-platform/universal-navigation#versioning) for more information about versioning.
+
+## Uni-nav Initialization
+
+The Header uses the `tcUniNav` method to initialize the nav with:
+
+- active tool name
+- active tool root route
+- current user, if logged in
+- action handler callbacks (e.g. navigation, log in, log out, sign up)
+
+Because the Platform UI hosts multiple tools, each time the user navigates to a new tool, the Header updates the uni-nav w/the active tool info.