Skip to content

Commit 52b465b

Browse files
committed
Improved summary
1 parent d928565 commit 52b465b

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,36 @@
55
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
66
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
77

8-
`CEDARScript Editor (Python)` is a Python library for interpreting `CEDARScript` scripts and
9-
performing code analysis and modification operations on a codebase.
8+
`CEDARScript Editor (Python)` is a [CEDARScript](https://github.com/CEDARScript/cedarscript-grammar#readme) runtime
9+
for interpreting `CEDARScript` scripts and performing code analysis and modification operations on a codebase.
10+
11+
CEDARScript enables offloading _low-level code syntax and structure concerns_, such as indentation and line counting,
12+
from the LLMs.
13+
The CEDARScript runtime _bears the brunt of file editing_ by locating the exact line numbers and characters to change,
14+
which indentation levels to apply to each line and so on, allowing the _CEDARScript commands_ to focus instead on
15+
**higher levels of abstraction**, like identifier names, line markers, relative indentations and positions
16+
(`AFTER`, `BEFORE`, `INSIDE` a function, its `BODY`, at the `TOP` or `BOTTOM` of it...)
1017

1118
## What is CEDARScript?
1219

1320
[CEDARScript](https://github.com/CEDARScript/cedarscript-grammar#readme) (_Concise Examination, Development, And Refactoring Script_)
14-
is a domain-specific language that aims to improve how AI coding assistants interact with codebases and communicate their code modification intentions.
21+
is a domain-specific language that aims to improve how AI coding assistants interact with codebases and communicate
22+
their code modification intentions.
23+
1524
It provides a standardized way to express complex code modification and analysis operations, making it easier for
1625
AI-assisted development tools to understand and execute these tasks.
1726

1827
## Features
1928

20-
- Given a `CEDARScript` script and a base direcotry, executes the script commands on files inside the base directory;
29+
- Given a `CEDARScript` script and a base directory, executes the script commands on files inside the base directory;
2130
- Return results in `XML` format for easier parsing and processing by LLM systems
2231

2332
## Installation
2433

2534
You can install `CEDARScript` Editor using pip:
2635

2736
```
28-
pip install cedarscript_editor
37+
pip install cedarscript-editor
2938
```
3039

3140
## Usage

0 commit comments

Comments
 (0)