Skip to content

Commit bdd6358

Browse files
authored
Deprecating the component (#18)
* chore: deprecating the component Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
1 parent 8ac9ddb commit bdd6358

File tree

3 files changed

+2742
-3735
lines changed

3 files changed

+2742
-3735
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
1-
[![Published on NPM](https://img.shields.io/npm/v/@api-components/api-documentation-document.svg)](https://www.npmjs.com/package/@api-components/api-documentation-document)
1+
# DEPRECATED
22

3-
[![Build Status](https://travis-ci.org/advanced-rest-client/api-documentation-document.svg?branch=stage)](https://travis-ci.org/advanced-rest-client/api-documentation-document)
3+
This component is being deprecated. The code base has been moved to [api-documentation](https://github.com/advanced-rest-client/api-documentation) module. This module will be archived when [PR 37](https://github.com/advanced-rest-client/api-documentation/pull/37) is merged.
44

5-
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/advanced-rest-client/api-documentation-document)
6-
7-
# api-documentation-document
5+
-----
86

97
A component to render documentation node of the AMF model
108

11-
129
```html
1310
<api-documentation-document amf="{...}" shape="{...}"></api-documentation-document>
1411
```
@@ -21,7 +18,8 @@ For compatibility with previous model version use `3.x.x` version of the compone
2118
## Usage
2219

2320
### Installation
24-
```
21+
22+
```ssh
2523
npm install --save @api-components/api-documentation-document
2624
```
2725

@@ -71,6 +69,7 @@ npm start
7169
```
7270

7371
### Running the tests
72+
7473
```sh
7574
npm test
7675
```

0 commit comments

Comments
 (0)