updated readme w/ readable instructions

README.md

@@ -1,7 +1,35 @@
 # Mcity-vue3-shared
-Common vue files/themed components used across projects
+Common vue header/nav & components used across Mcity projects.
 
-# Usage
+## Requirements
+
+Mcity-vue3-auth uses a number of open source projects to work properly:
+-  Node version ~14.0.0 
+- [[Vue.js](https://vuejs.org/) v3] - Used for our frontend.
+
+## Env Setup
+
+- Create file `.env.local` if it does not already exist.
+- Add the following variables to this file.
+
+```
+GITHUB_PACKAGES_TOKEN="Create token at https://github.com/settings/tokens"
+```
+
+## Toolbar
+1. Import the `McityToolbar` component with
+`import McityToolbar from '@mcity/mcity-vue3-shared/components/McityToolbar'`
+2. Include the toolbar component in the template for `app.vue` with `<mcity-toolbar><mcity-toolbar/>`
+3. Pass the following required props
+    - fullname
+    - username
+    - presentation-text
+    - isUserAdmin
+    - title
+4. There is a named slot available titled "buttons" when any app-specific toolbar buttons can be placed (see example below).
+5. There is another slot, "overflow-buttons" which maps to inside the ellipses menu on the far right of the toolbar.
+
+## Usage
 ### Example:
 ```
 <mcity-toolbar
@@ -23,86 +51,30 @@ Common vue files/themed components used across projects
 </mcity-toolbar>
 ```
 
-## Toolbar
-1. Import the `McityToolbar` component with
-`import McityToolbar from '@mcity/mcity-vue3-shared/components/McityToolbar'`
-2. Include the toolbar component in the template for `app.vue` with `<mcity-toolbar><mcity-toolbar/>`
-3. Pass the following required props
-    - fullname
-    - username
-    - presentation-text
-    - isUserAdmin
-    - title
-4. There is a named slot available titled "buttons" when any app-specific toolbar buttons can be placed (see example below).
-5. There is another slot, "overflow-buttons" which maps to inside the ellipses menu on the far right of the toolbar.
-
-
-# base
-
 ## Project setup
 
 ```
-# yarn
-yarn
-
 # npm
 npm install
-
-# pnpm
-pnpm install
-
-# pnpm
-bun install
 ```
 
 ### Compiles and hot-reloads for development
 
 ```
-# yarn
-yarn dev
-
 # npm
 npm run dev
-
-# pnpm
-pnpm dev
-
-# bun
-bun run dev
 ```
 
 ### Compiles and minifies for production
 
 ```
-# yarn
-yarn build
-
 # npm
 npm run build
-
-# pnpm
-pnpm build
-
-# bun
-bun run build
 ```
 
 ### Lints and fixes files
 
 ```
-# yarn
-yarn lint
-
 # npm
 npm run lint
-
-# pnpm
-pnpm lint
-
-# bun
-bun run lint
-```
-
-### Customize configuration
-
-See [Configuration Reference](https://vitejs.dev/config/).
+```