Skip to content

Commit 24bb54b

Browse files
authored
doc: update (#15)
* update ci * udpate ci * update * update * update * update
1 parent f9eceaa commit 24bb54b

File tree

3 files changed

+8
-48
lines changed

3 files changed

+8
-48
lines changed

.golangci.yaml

Lines changed: 0 additions & 36 deletions
This file was deleted.

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,25 @@
33
![ABCoder](images/ABCoder.png)
44

55
# Overview
6-
ABCoder, an AI-oriented code-processing SDK, is designed to enhance coding context for Large-Language-Model (LLM), and boost developing AI-assisted-coding applications.
6+
ABCoder, an general AI-oriented code-processing SDK, is designed to enhance coding context for Large-Language-Model (LLM), and boost developing AI-assisted-programming applications.
77

88

99
## Features
1010

11-
- Universal Abstract Syntax Tree (UniAST), an language-independent, AI-friendly specification of code information, providing a flexible and structrual coding context for both AI and hunman.
11+
- Universal Abstract-Syntax-Tree (UniAST), an language-independent, AI-friendly specification of code information, providing a boundless, flexible and structrual coding context for both AI and hunman.
1212

1313
- General Parser, parses abitary-language codes to UniAST.
1414

1515
- General Writer, transforms UniAST back to codes.
1616

17-
- (Comming Soon) General Iterator, a framework for visiting the UniAST easily and implementing batch-code-processing workflows.
17+
- (Comming Soon) General Iterator, a framework for visiting the UniAST and implementing code-batch-processing workflows.
1818

19-
- (Comming Soon) Code RAG, provides a set of tools and functions to help the LLM understand your codes much deeper than ever.
19+
- (Comming Soon) Code Retrieval-Augmented-Generation (RAG), provides a set of tools and functions to help the LLM understand your codes much deeper than ever.
2020

21-
Based on these features, developers can easily implement or enhance their AI-assisted-coding applications, such as reviewing, optimizing, translating, etc.
21+
Based on these features, developers can easily implement or enhance their AI-assisted-programming applications, such as reviewing, optimizing, translating, etc.
2222

2323

24-
## Universal-Abstract-Syntax-Tree Specification
24+
## Universal Abstract-Syntax-Tree Specification
2525

2626
see [UniAST Specification](docs/uniast-zh.md)
2727

@@ -37,7 +37,7 @@ go install github.com/cloudwego/abcoder@latest
3737
abcoder parse {language} {repo-path} > ast.json
3838
```
3939
3. Do your magic with UniAST...
40-
4. Use ABCoder to write a UniAST back to codes
40+
4. Use ABCoder to write an UniAST back to codes
4141
```bash
4242
abcoder write {language} ast.json
4343
```
@@ -58,7 +58,7 @@ ABCoder currently supports the following languages:
5858
# Getting Involved
5959

6060
We encourage developers to contribute and make this tool more powerful. If you are interested in contributing to ABCoder
61-
project, kindly check out our Getting Involved Guide:
61+
project, kindly check out our guide:
6262
- [Parser Extension](docs/parser-zh.md)
6363

6464
> Note: This is a dynamic README and is subject to changes as the project evolves.

_typos.toml

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)