@worktile/gantt 12.0.1 → 12.0.2

package/README.md

@@ -1,127 +1,24 @@
-# ngx-gantt
+# Gantt
 
-[![CircleCI](https://circleci.com/gh/worktile/ngx-gantt.svg?style=shield)](https://circleci.com/gh/worktile/ngx-gantt)
-[![Coverage Status][coveralls-image]][coveralls-url]
-[![npm (scoped)](https://img.shields.io/npm/v/@worktile/gantt?style=flat)](https://www.npmjs.com/package/@worktile/gantt)
-[![npm](https://img.shields.io/npm/dm/@worktile/gantt)](https://www.npmjs.com/package/@worktile/gantt)
-![npm bundle size (scoped)](https://img.shields.io/bundlephobia/min/@worktile/gantt)
-[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
+This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 8.2.14.
 
-[coveralls-image]: https://coveralls.io/repos/github/worktile/ngx-gantt/badge.svg?branch=master
-[coveralls-url]: https://coveralls.io/github/worktile/ngx-gantt
+## Code scaffolding
 
-A modern and powerful gantt component for Angular
+Run `ng generate component component-name --project gantt` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project gantt`.
+> Note: Don't forget to add `--project gantt` or else it will be added to the default project in your `angular.json` file. 
 
-## Installation
+## Build
 
-```bash
-$ npm i @worktile/gantt --save
-# or
-$ yarn add @worktile/gantt
-```
+Run `ng build gantt` to build the project. The build artifacts will be stored in the `dist/` directory.
 
-## Demo
+## Publishing
 
-[Try out our live demo](http://gantt.ngnice.com/)
+After building your library with `ng build gantt`, go to the dist folder `cd dist/gantt` and run `npm publish`.
 
-## Usage
+## Running unit tests
 
-### 1. Import the NgxGanttModule to use into your app.module.ts
+Run `ng test gantt` to execute the unit tests via [Karma](https://karma-runner.github.io).
 
-```ts
-import { NgModule } from '@angular/core';
-import { NgxGanttModule } from '@worktile/gantt';
+## Further help
 
-@NgModule({
-  ...
-  imports: [ NgxGanttModule, ... ]
-  ...
-})
-export class AppModule {
-
-}
-```
-
-### 2. Import style file in angular.json or import style in your style.scss
-
-```json
-{
-  "styles": ["node_modules/@worktile/gantt/main.bundle.scss"]
-}
-```
-
-```scss
-@import '~@worktile/gantt/main.bundle.scss';
-```
-
-### 3. Using component
-
-component.html
-
-```html
-<ngx-gantt #gantt [items]="items">
-  <ngx-gantt-table>
-    <ngx-gantt-column name="Title" width="300px">
-      <ng-template #cell let-item="item"> {{ item.title }} </ng-template>
-    </ngx-gantt-column>
-  </ngx-gantt-table>
-</ngx-gantt>
-```
-
-component.ts
-
-```javascript
-@Component({
-  selector: 'app-gantt-example',
-  templateUrl: './gantt.component.html'
-})
-export class AppGanttExampleComponent {
-  items: GanttItem[] = [
-    { id: '000000', title: 'Task 0', start: 1627729997, end: 1628421197 },
-    { id: '000001', title: 'Task 1', start: 1617361997, end: 1625483597 }
-  ];
-
-  constructor() {}
-}
-```
-
-See [Getting Started](http://gantt.ngnice.com/guides/getting-started) for more details.
-
-## Development
-
-```bash
-$ git clone git@github.com:worktile/ngx-gantt.git
-$ cd ngx-gantt
-$ npm install
-$ npm run start
-```
-
-## Roadmap
-
-- [ ] virtual scrolling
-
-## Contributors ✨
-
-Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
-
-<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
-<table>
-  <tr>
-    <td align="center"><a href="https://github.com/walkerkay"><img src="https://avatars.githubusercontent.com/u/15701592?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Walker</b></sub></a><br /><a href="#question-walkerkay" title="Answering Questions">💬</a> <a href="https://github.com/walkerkay/ngx-gantt/commits?author=walkerkay" title="Code">💻</a> <a href="#design-walkerkay" title="Design">🎨</a> <a href="https://github.com/walkerkay/ngx-gantt/commits?author=walkerkay" title="Documentation">📖</a> <a href="#infra-walkerkay" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-walkerkay" title="Maintenance">🚧</a> <a href="#projectManagement-walkerkay" title="Project Management">📆</a> <a href="https://github.com/walkerkay/ngx-gantt/pulls?q=is%3Apr+reviewed-by%3Awalkerkay" title="Reviewed Pull Requests">👀</a></td>
-    <td align="center"><a href="https://github.com/HandsomeButterball"><img src="https://avatars.githubusercontent.com/u/17664721?v=4?s=100" width="100px;" alt=""/><br /><sub><b>zhangwen</b></sub></a><br /><a href="https://github.com/walkerkay/ngx-gantt/commits?author=HandsomeButterball" title="Code">💻</a></td>
-    <td align="center"><a href="https://github.com/mengshuicmq"><img src="https://avatars.githubusercontent.com/u/13193164?v=4?s=100" width="100px;" alt=""/><br /><sub><b>cmq</b></sub></a><br /><a href="https://github.com/walkerkay/ngx-gantt/commits?author=mengshuicmq" title="Code">💻</a></td>
-  </tr>
-</table>
-
-<!-- markdownlint-restore -->
-<!-- prettier-ignore-end -->
-
-<!-- ALL-CONTRIBUTORS-LIST:END -->
-
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
-
-## LICENSE
-
-[MIT License](https://github.com/worktile/ngx-gantt/blob/master/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).