From 8576746feb27f85e5211dc6d5312d58e7e231357 Mon Sep 17 00:00:00 2001 From: Gloria Date: Tue, 10 Jan 2023 20:22:05 +0800 Subject: [PATCH] updated readme (EN) Signed-off-by: Gloria --- README.md | 30 ++++++++++++++++++++++++++++++ README_en.md | 8 -------- 2 files changed, 30 insertions(+), 8 deletions(-) create mode 100644 README.md delete mode 100644 README_en.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..d7037e8c2 --- /dev/null +++ b/README.md @@ -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) diff --git a/README_en.md b/README_en.md deleted file mode 100644 index e5bb3ba33..000000000 --- a/README_en.md +++ /dev/null @@ -1,8 +0,0 @@ -# API Declaration File Public Repository - -- [Introduction](#section11660541593) - -## Introduction - -JavaScript API public repository which is used to submit API d.ts Declaration File. -