Commit 75e78766 authored by Zéfling's avatar Zéfling 🎨

Rewrite README

parent 44fcb351
# ColorationDemo
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 7.0.4.
# Coloration
## Development server
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 7.0.4.
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
## Installation
## Code scaffolding
```
npm i coloration-lib --save
```
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
## Requirements
## Build
Only for demo:
- Angular 7.0.0 and more
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
## Usage
## Running unit tests
Example:
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
```typescript
const color = new Coloration('red');
color.addColor({
h: -23,
v: 10,
});
console.log(color.toHEX()); // #ff3381
```
## Running end-to-end tests
## Publishing the library
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
```
ng build coloration-demo --prod
cp *.md dist/coloration-lib
cd dist/coloration-lib
npm publish
```
## Further help
## License
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
This module is released under the permissive MIT license. Your contributions are always welcome.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment