From 2556e625f21c34805740ba9930158d0e40fd1b05 Mon Sep 17 00:00:00 2001 From: Choe Changwon Date: Sun, 18 Jun 2023 14:41:10 +0900 Subject: [PATCH] recover README.md and CI file --- .github/workflows/deploy.yml | 2 +- README.md | 30 ++++++------------------------ 2 files changed, 7 insertions(+), 25 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index d540e4d..de39cf7 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -12,7 +12,7 @@ jobs: strategy: matrix: - node-version: [15.x, 16.x] + node-version: [16.x] steps: - uses: actions/checkout@v3 diff --git a/README.md b/README.md index 0816274..d7360ca 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,9 @@ -# NgTerminal13 +[![Pull Request](https://github.com/qwefgh90/ng-terminal/actions/workflows/test.yml/badge.svg?label=Pull%20Request)](https://github.com/qwefgh90/ng-terminal/actions) +[![Master](https://github.com/qwefgh90/ng-terminal/actions/workflows/deploy.yml/badge.svg?label=Master)](https://github.com/qwefgh90/ng-terminal/actions) +[![version](https://badge.fury.io/js/ng-terminal.svg)](https://www.npmjs.com/package/ng-terminal) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)]() -This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 13.3.11. +**NgTerminal** is a component to create a terminal emulator in Angular. It completely leverages [Xterm.js](https://xtermjs.org/). -## Development server +The objective is to provides only Angular developers with both easy installation and some convenient features during the development of an Angular app including an terminal functionality. Currently, it has some features such as NgTerminal Component, Draggable. -Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files. - -## Code scaffolding - -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`. - -## Build - -Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. - -## Running unit tests - -Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). - -## Running end-to-end tests - -Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities. - -## Further help - -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. +We provide [Wiki](https://github.com/qwefgh90/ng-terminal/wiki) for a collection of guides such as APIs, Control Sequence and Contributing. \ No newline at end of file