Merge pull request #33 from gjovanovicst/main

Update documentations and dependencies

Gruntfile.js

@@ -21,13 +21,13 @@ module.exports = function (grunt) {
       //     }
       //   },
 
-      files: ['packages/core/package.json', 'packages/angular/package.json', 'packages/react/package.json', 'packages/vue/package.json']
+      files: ['packages/core/package.json', 'packages/angular/package.json', 'packages/angular/projects/anywhere-ui/package.json', 'packages/react/package.json', 'packages/vue/package.json']
     },
     buildnumber: {
       options: {
         field: 'buildnum',
       },
-      files: ['packages/core/package.json', 'packages/angular/package.json', 'packages/react/package.json', 'packages/vue/package.json']
+      files: ['packages/core/package.json', 'packages/angular/package.json', 'packages/angular/projects/anywhere-ui//package.json', 'packages/react/package.json', 'packages/vue/package.json']
     }
 
   });

README.md

@@ -14,14 +14,18 @@ Visit the [AnywhereUI Website](https://adaleks.github.io/anywhere-ui-showcase/)
 | Project | Package | Version | Links |
 | ------- | ------- | ------- |:-----:|
 | **Core** | [`@anywhere-ui/core`](https://www.npmjs.com/package/@anywhere-ui/core) | [![npm version](https://badge.fury.io/js/@anywhere-ui%2Fcore.svg)](https://badge.fury.io/js/@anywhere-ui%2Fcore) | [`README.md`](packages/core/README.md) |
+| **Angular** | [`@anywhere-ui/angular`](https://www.npmjs.com/package/@anywhere-ui/angular) | [![npm version](https://badge.fury.io/js/@anywhere-ui%2Fangular.svg)](https://badge.fury.io/js/@anywhere-ui%2Fangular) | [`README.md`](packages/angular/README.md) |
+| **Vue** | [`@anywhere-ui/vue`](https://www.npmjs.com/package/@anywhere-ui/vue) | [![npm version](https://badge.fury.io/js/@anywhere-ui%2Fvue.svg)](https://badge.fury.io/js/@anywhere-ui%2Fvue) | [`README.md`](packages/vue/README.md) |
+| **React** | [`@anywhere-ui/react`](https://www.npmjs.com/package/@anywhere-ui/react) | [![npm version](https://badge.fury.io/js/@anywhere-ui%2Freact.svg)](https://badge.fury.io/js/@anywhere-ui%2Freact) | [`README.md`](packages/react/README.md) |
 
 ## Getting Started
 
-To start building a new AnywhereUI web component using Stencil, fork this repo and clone to a new directory:
+To start building a new AnywhereUI web component using Stencil, fork this repo and clone to a new directory.
+
+Navigate into the project directory:
 
-```bash
-git clone https://github.com/{github_username}/anywhere-ui.git
 
+```bash
 cd anywhere-ui
 ```
 

packages/angular/README.md

@@ -1,68 +1,29 @@
-# Angular
+# AnywhereUI - Angular
 
 Angular has a pretty good story for integration with web components but there are a few issues with the developer experience. If you want to know what the story is without the bindings go here: https://stenciljs.com/docs/angular.
 
 With bindings the web components get wrapped in an Angular component and then immediately become available as Angular Components. Some of the advantages of doing this are that you get types for your components and you also get the ability to use ngmodel on inputs. Your developers then consuming your web components from Angular applications import an actual Angular Library and to them it feels as though they are interacting with Angular components.
 
-## Install
-
-```bash
-npm install @anywhere-ui/angular
-```
-
-## Style
-
-The css dependencies should be added in `angular.json` file
-
-```json
-{
-  ...
-
-  "build": {
-    ...
-
-    "options": {
-      "styles": [
-          "./node_modules/@anywhere-ui/core/dist/anywhere-ui/anywhere-ui.css"
-      ],
-    }
-  },
-  ...
-
-  "test": {
-    "styles": [
-        "./node_modules/@anywhere-ui/core/dist/anywhere-ui/anywhere-ui.css"
-    ],
-  }
+## Build
 
-  ...
+Run:
 
-}
+```bash
+ng build anywhere-ui
 ```
 
-## Usage
+to build the project. The build artifacts will be stored in the `dist/` directory.
 
-```ts
-import { AnywhereUiModule } from '@anywhere-ui/angular';
+## How to release a new version
 
-@NgModule({
-  ...
-  imports: [
-    AnywhereUiModule
-  ],
-  ...
-})
-export class AppModule { }
-```
+- Build the core package
+- Run build on this package
+- After building your library with `ng build anywhere-ui`, go to the dist folder `cd dist/anywhere-ui` and run `npm publish`.
 
-## Build
+## Running unit tests
 
-```bash
-ng build --configuration=production
-```
+Run `ng test anywhere-ui` to execute the unit tests via [Karma](https://karma-runner.github.io).
 
-## How to release a new version
+## Further help
 
-- Build the core package
-- Run build on this package
-- Publish
+To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.