Skip to content

Commit 8e62e70

Browse files
authored
Update README.md (#163)
# Motivation <!-- Why is this change necessary? --> # Content <!-- Please include a summary of the change --> # Testing <!-- How was the change tested? --> # Please check the following before marking your PR as ready for review - [ ] I have added tests for my changes - [ ] I have updated the documentation or added new documentation as needed - [ ] I have read and agree to the [Contributor License Agreement](../CLA.md)
1 parent 3c9ae50 commit 8e62e70

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,21 @@
22

33
<p align="center">
44
<a href="https://docs.codegen.com">
5-
<img src="https://github.com/user-attachments/assets/3ab806b5-c3bb-42f8-ac82-177cfd7e1732" />
5+
<img src="https://github.com/user-attachments/assets/fdb2cd83-9967-41c2-a93d-cddff267ac79" />
66
</a>
77
</p>
88

99
<h2 align="center">
10-
The Pythonic interface to transform your code.
10+
Scriptable interface to a powerful, multi-lingual language server.
1111
</h2>
1212

1313
<div align="center">
1414

1515
[![PyPI](https://img.shields.io/pypi/v/codegen?style=flat-square&color=blue)](https://pypi.org/project/codegen/)
1616
[![Documentation](https://img.shields.io/badge/docs-docs.codegen.com-purple?style=flat-square)](https://docs.codegen.com)
1717
[![Slack Community](https://img.shields.io/badge/slack-community-4A154B?logo=slack&style=flat-square)](https://community.codegen.com)
18-
[![Follow on X](https://img.shields.io/twitter/follow/codegen?style=social)](https://x.com/codegen)
18+
[![License](https://img.shields.io/badge/Code%20License-Apache%202.0-gray?&color=gray)](https://github.com/codegen-sh/codegen-sdk/tree/develop?tab=Apache-2.0-1-ov-file)
19+
[![Follow on X](https://img.shields.io/twitter/follow/codegen?style=social)](https://x.com/codegen)
1920

2021
</div>
2122

@@ -41,7 +42,8 @@ for function in codebase.functions:
4142
Write code that transforms code. Codegen combines the parsing power of [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) with the graph algorithms of [rustworkx](https://github.com/Qiskit/rustworkx) to enable scriptable, multi-language code manipulation at scale.
4243

4344
## Installation and Usage
44-
**This library requires Python 3.12 – 3.13.**
45+
This library requires **Python 3.12 – 3.13**. Currently, Codegen only supports macOS.
46+
4547
```
4648
# Install inside existing project
4749
uv pip install codegen
@@ -54,7 +56,7 @@ cd path/to/repo
5456
codegen init
5557
codegen create test-function
5658
57-
# Run said codemod
59+
# Run the codemod
5860
codegen run test-function
5961
6062
# Create an isolated venv with codegen => open jupyter
@@ -63,20 +65,18 @@ codegen notebook
6365

6466
## Usage
6567

66-
See [https://docs.codegen.com/introduction/getting-started] for a full tutorial.
68+
See [Getting Started](https://docs.codegen.com/introduction/getting-started) for a full tutorial.
6769

6870
```
6971
from codegen import Codebase
70-
7172
```
7273

7374
## Resources
7475

7576
- [Docs](https://docs.codegen.com)
76-
- [Get Started](https://docs.codegen.com/introduction/getting-started)
77+
- [Getting Started](https://docs.codegen.com/introduction/getting-started)
7778
- [Contributing](CONTRIBUTING.md)
7879

79-
8080
## Why Codegen?
8181

8282
Software development is fundamentally programmatic. Refactoring a codebase, enforcing patterns, or analyzing control flow - these are all operations that can (and should) be expressed as programs themselves.

0 commit comments

Comments
 (0)