Change readme + add license + add logo (#33)

LICENSE → LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Sebastien
+Copyright (c) 2020 Lighting Web Chart.js Component (LWCC) Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,17 +1,10 @@
-<h1 align="center">
-	TODO logo  
-</h1>
-
-<h4 align="center">
-	<a href="#overview">Overview</a> |
-	<a href="#installation-instructions">Install Me</a> |
-	<a href="#how-it-works">How it Works</a> |
-	<a href="#faqs">FAQs</a> |
-	<a href="#contributing">Contribute</a>
-</h4>
+<div align="center">
+	<img src="assets/images/lwcc_logo.png" width="256">
+	<h1>Lightning Web Chart.js Component</h1>
+</div>
 
-<h3 align="center">
-	An interactive Lightning Web Component for the Salesforce platform<br><br>
+<div align="center">
+	<h3>Simple yet flexible charting Lightning Web Component using Chart.js for admins & developers</h3>
 	<a href="https://github.com/scolladon/lwcc/network/members">
     		<img alt="forks on github"
 		src="https://img.shields.io/github/forks/scolladon/lwcc?style=flat-square&logoColor=blue">
@@ -31,82 +24,20 @@
 	<a href="https://codecov.io/gh/scolladon/lwcc">
 		<img alt="coverage" src="https://codecov.io/gh/scolladon/lwcc/branch/master/graph/badge.svg" />
 	</a>
-</h3>
-
-<p align="center">
-  TODO gif image
-</p>
-
-## Overview
-
-ChartJs in Lightning Web Compoponent. Allow developer to build chart component using ChartJs. Allow admin to compose page using those chart component
-
-- **ChartJs base chart** Line, bar, radar, doughnut & pie, polar area, bubble, scatter, area chart.
-- **ChartJs Mix chart** Support for mix chart using custom lightning web component.
-- **ChartJs axes** Axes definition using custom lightning web component.
-- **ChartJs events** Support for custom event handler in your application
-- **Responsive chart.** Use ChartJs responsive APIs.
-- **App builder support.** TODO
-
-> This sample application is designed to run on Salesforce Platform. If you want to experience Lightning Web Components on any platform, please visit https://lwc.dev, and try out the Lightning Web Components sample application [LWC Recipes OSS](https://github.com/trailheadapps/lwc-recipes-oss).
-
-## Installation Instructions
-
-TODO to revise when the component will be in a managed package
-
-1. Set up your environment. Follow the steps in the [Quick Start: Lightning Web Components](https://trailhead.salesforce.com/content/learn/projects/quick-start-lightning-web-components/) Trailhead project. The steps include:
-
-- Enable Dev Hub in your Trailhead Playground
-- Install Salesforce CLI
-- Install Visual Studio Code
-- Install the Visual Studio Code Salesforce extensions, including the Lightning Web Components extension
-
-2. If you haven't already done so, authenticate with your hub org and provide it with an alias (**myhuborg** in the command below):
-
-```
-sfdx force:auth:web:login -d -a myhuborg
-```
-
-3. Clone the lwcc repository:
+</div>
 
-```
-git clone https://github.com/scolladon/lwcc
-cd lwcc
-```
+## Documentation
 
-4. Create a scratch org and provide it with an alias (**lwcc** in the command below):
+- [Getting started](https://scolladon.github.io/lwcc/)
+- [API Documentation](https://scolladon.github.io/lwcc/docs/api.html)
+  - [Chart](https://scolladon.github.io/lwcc/docs/api/chart.html)
+  - [Data](https://scolladon.github.io/lwcc/docs/api/data.html)
+  - [Attributes](https://scolladon.github.io/lwcc/docs/api/attributes.html)
+  - [Axes](https://scolladon.github.io/lwcc/docs/api/axes.html)
+- [Samples](https://scolladon.github.io/lwcc/docs/general/samples.html)
+- [About the project](https://scolladon.github.io/lwcc/docs/general/about.html)
+- [Playground](https://scolladon.github.io/lwcc/docs/general/playground.html)
 
-```
-sfdx force:org:create -s -f config/project-scratch-def.json -a lwcc
-```
-
-5. Push the app to your scratch org:
-
-```
-sfdx force:source:push
-```
-
-6. Assign the Lightning_Web_Chart_Component permission set to the default user:
-
-```
-sfdx force:user:permset:assign -n Lightning_Web_Chart_Component
-```
-
-7. Open the scratch org:
-
-```
-sfdx force:org:open
-```
-
-8. Start composing application using the chart components or by creating your own using the library.
-
-## How to use it
-
-cf [documentation](https://scolladon.github.io/lwcc/)
-
-### How to build your App builder embeddable chart component TODO
-
-### How to build custom Lightning application TODO
 
 ## Contributing
 
@@ -128,3 +59,6 @@ See [contributing.md](/CONTRIBUTING.md) for lwcc principles.
 #### Code linting
 
 [ESLint](https://eslint.org/) is a popular JavaScript linting tool used to identify stylistic errors and erroneous constructs. To use ESLint with Visual Studio Code, install [this extension](https://marketplace.visualstudio.com/items?itemName=salesforce.salesforcedx-vscode-lwc) from the Visual Studio Code Marketplace. The [.eslintignore](/.eslintignore) file is provided as part of this repository to exclude specific files from the linting process in the context of Lightning Web Components development.
+
+## License
+LWCC is available under the [MIT license](LICENSE.md)