updated readme (EN)

Signed-off-by: Gloria <wusongqing@huawei.com>
This commit is contained in:
Gloria 2023-01-10 20:22:05 +08:00
parent 68471edcf1
commit 8576746feb
2 changed files with 30 additions and 8 deletions

30
README.md Normal file
View File

@ -0,0 +1,30 @@
# Public Repository for API Declaration Files
## Overview
This repository is used to store .d.ts declaration files of JavaScript/TypeScript APIs and API-related tools.
## Directory Structure
```
├─api
| ├─@internal
│ | ├─component
│ | | └─ets # Declaration file for components in the TypeScript-based declarative development paradigm
| | └─ets
| ├─config # JavaScript-based web-like development paradigm
| ├─form # JavaScript service widget
| ├─@ohos.×××.d.ts # API declaration file
| └─@system.×××.d.ts # Deprecated APIs
├─build-tools
├─api_check_plugin # Tool for checking API specifications
| ├─plugin
| ├─src
| └─test
└─collect_application_api # Tool for parsing used APIs
└─src
```
## Repositories Involved
[interface-sdk_js](https://gitee.com/openharmony/interface_sdk-js/tree/master)

View File

@ -1,8 +0,0 @@
# API Declaration File Public Repository<a name="US-EN_TOPIC_0000001151209521"></a>
- [Introduction](#section11660541593)
## Introduction<a name="section11660541593"></a>
JavaScript API public repository which is used to submit API d.ts Declaration File.