Merge pull request #5 from callums/master

Update/delete readmes

Author: cal-smith

.travis.yml

@@ -16,5 +16,5 @@ deploy:
   provider: script
   script: bash ./scripts/deploy.sh
   on:
-    all_branches: true
+    branch: master
     repo: ibm/carbon-components-angular

README.md

@@ -1,56 +1,16 @@
-# Neutrino
-A componentized _Angular_ implementation of the Watson Customer Engagement design guide.
+# Carbon Components Angular
+An _Angular_ implementation of the Carbon Design System
 
 ### Getting started
 
-To quickly start developing new apps or demos, use
-<a href="https://github.ibm.com/peretz/neutrino-seed">
 ```
-     __           _        _               __               _
-  /\ \ \___ _   _| |_ _ __(_)_ __   ___   / _\ ___  ___  __| |
- /  \/ / _ \ | | | __| '__| | '_ \ / _ \  \ \ / _ \/ _ \/ _` |
-/ /\  /  __/ |_| | |_| |  | | | | | (_) | _\ \  __/  __/ (_| |
-\_\ \/ \___|\__,_|\__|_|  |_|_| |_|\___/  \__/\___|\___|\__,_|
+$ npx @angular/cli new my-project
+$ cd my-project
+$ npm i carbon-components-angular carbon-components
+$ # include carbon css
+$ # import components
+$ npm start
 ```
-</a>
-
-Follow instructions in [Neutrino Seed repo](https://github.ibm.com/peretz/neutrino-seed) and use the rest of this readme if you need more detailed information.
-<a href="https://pages.github.ibm.com/peretz/neutrino/documentation">
-```
-    ___                                      _        _   _
-   /   \___   ___ _   _ _ __ ___   ___ _ __ | |_ __ _| |_(_) ___  _ __
-  / /\ / _ \ / __| | | | '_ ` _ \ / _ \ '_ \| __/ _` | __| |/ _ \| '_ \
- / /_// (_) | (__| |_| | | | | | |  __/ | | | || (_| | |_| | (_) | | | |
-/___,' \___/ \___|\__,_|_| |_| |_|\___|_| |_|\__\__,_|\__|_|\___/|_| |_|
-```
-</a>
-
-#### Artifactory
-
-Run the following to add the needed information
-to your `~/.npmrc`. Replace `[email protected]` with your actual IBM email address and use your w3id password to
-authenticate when asked.
-
-```bash
-curl [email protected] https://na.artifactory.swg-devops.com/artifactory/api/npm/wce-peretz-npm-local/auth/peretz >> ~/.npmrc
-```
-
-##### Can't use `curl`?
-
-In case if you don't wanna use curl command to setup the config in .npmrc file, here are the alternative steps. (Specially for Windows users):
-
-1) Login to this page with your w3id credentials
-https://na.artifactory.swg-devops.com/artifactory/webapp/#/home
-2) Go to home page
-3) on the *set me up* card, type 'peretz' into the search box
-4) click on wce-peretz-npm-local
-5) A dialog will appear, in that Add your credentials at the top right corner
-6) Inside the same dialog, there is a section _using basic authentication_ copy and paste the same info in your `.npmrc` file _(in Windows `%USERPROFILE%/.npmrc`)_
-7) save your changes and try npm update
-
-##### Getting errors?
-
-If you recently changed you w3id password, you'll get an error like `npm ERR! 403 Forbidden: @peretz/neutrino@...` and you will have to update your `~/.npmrc` by retaking the "Artifactory" step. Remove references to `peretz` from it before, or delete the whole file if you can (i.e. if peretz libraries are only thing you use from artifactory).
 
 #### Bundler
 
@@ -72,7 +32,7 @@ Then you'll be able to `npm install @peretz/neutrino` and `npm install @peretz/m
 - **if you are contributing a fix**:
   - add your fix, update the documentation as needed
   - consider adding or modifying a test case to cover the fix
-- follow the [Neutrino style guide](https://github.ibm.com/peretz/neutrino/wiki/Style-guide), [Angular style guide](https://angular.io/styleguide) and [our general component guidelines](https://github.ibm.com/peretz/neutrino/wiki/General-component-API-guidelines)
+- follow the [Angular style guide](https://angular.io/styleguide)
 - be sure to run `npm test` and `npm run lint` to make sure the tests and linter pass
 - DO NOT change the version number.
 - submit a PR
@@ -101,30 +61,27 @@ Then you'll be able to `npm install @peretz/neutrino` and `npm install @peretz/m
   - current behaviour
   - screenshots if needed
   - relevant code snippets
-  - links to application source code or running demo (including connection/authentication information)
+  - links to application source code or running demo ([Codesandbox is awesome for this!](https://codesandbox.io/s/angular)) (including connection/authentication information)
 - add relevant labels (bug, accsibility, design, discussion, feature, etc)
 - if you have a fix to contribute, assign yourself, otherwise leave unassigned
 
 #### npm commands
-To keep our build dependancies local we use npm scripts to run our webpack, gulp, and general build tasks. You should never install webpack or gulp globally as that will likely conflict with our version. You should never need to modify the build process to add a component or demo.
-- `npm run demo:server` to run the demo server (port 9000)
-- `npm run demo:build` to build the demo
+To keep our build dependancies local we use npm scripts to run our webpack, gulp, and general build tasks. You should never install webpack or gulp globally as that will likely conflict with our version. You should never need to modify the build process to add a component or story.
+- `npm run storybook` to run storybook (port 6006)
 - `npm run build` to generate the dist
 - `docs:build` to build documentation
 - `docs:server` to build and run the documentation server
 - `npm run lint` to run tslint
 - `npm test` to run tests
 
 ### Resources
- - [Neutrino style guide](https://github.ibm.com/peretz/neutrino/wiki/Style-guide)
- - [General component API guidelines](https://github.ibm.com/peretz/neutrino/wiki/General-component-API-guidelines)
+ - [Style guide (WIP)](#)
+ - [General component API guidelines (WIP)](#)
  - [Angular style guide](https://angular.io/styleguide)
  - [I18N tooling](https://angular.io/docs/ts/latest/cookbook/i18n.html)
  - (Angular 2+ doesn't have anything like ngAria, instead here's [The A11Y Project](http://a11yproject.com/), [WAI-ARIA specs](https://www.w3.org/TR/wai-aria/), and [WAI-ARIA Authoring Practices](https://www.w3.org/TR/2016/WD-wai-aria-practices-1.1-20160317/))
- - [CDL master files and microguides (May 2018)](https://ibm.box.com/v/May2018MasterfileMicroguidePDF)
  - [TypeScript docs](https://www.typescriptlang.org/docs/tutorial.html)
- - [Dynamic Assessment Plugin (aka. DAP/RPT)](https://w3-connections.ibm.com/wikis/home?lang=en-us#!/wiki/W88ee03f8907c_412b_a3a8_988dabb72b35/page/Dynamic%20Assessment%20Plugin) - now shipping a pretty solid chrome plugin
- - [CDL Icon Library](https://icon.stage1.mybluemix.net/) - Note only the icons in the "MASTER SET" sets are maintained
+
 
 ### Philosophy
 - Components should be the smallest unit of computation
@@ -137,8 +94,3 @@ To keep our build dependancies local we use npm scripts to run our webpack, gulp
   - Likewise, stateless components should be favored whenever possible
 - Components should NOT *necessarily* implement the style guide point-for-point, the guide simply provides guidance on overarching functionality, components should enable that and product specific designs **without** baking in extra functionality
 
-### Contact
-
-[Send feedback](https://peretz.slack.com/messages/C6DS43Y5N)
-
-[Ask a question](https://peretz.slack.com/messages/C6DS43Y5N)