diff --git a/README.md b/README.md index e6a991ede..1759d94cb 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,12 @@

- +

- The Pythonic interface to transform your code. + Scriptable interface to a powerful, multi-lingual language server.

@@ -15,7 +15,8 @@ [![PyPI](https://img.shields.io/pypi/v/codegen?style=flat-square&color=blue)](https://pypi.org/project/codegen/) [![Documentation](https://img.shields.io/badge/docs-docs.codegen.com-purple?style=flat-square)](https://docs.codegen.com) [![Slack Community](https://img.shields.io/badge/slack-community-4A154B?logo=slack&style=flat-square)](https://community.codegen.com) -[![Follow on X](https://img.shields.io/twitter/follow/codegen?style=social)](https://x.com/codegen) +[![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) +[![Follow on X](https://img.shields.io/twitter/follow/codegen?style=social)](https://x.com/codegen)
@@ -41,7 +42,8 @@ for function in codebase.functions: 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. ## Installation and Usage -**This library requires Python 3.12 – 3.13.** +This library requires **Python 3.12 – 3.13**. Currently, Codegen only supports macOS. + ``` # Install inside existing project uv pip install codegen @@ -54,7 +56,7 @@ cd path/to/repo codegen init codegen create test-function -# Run said codemod +# Run the codemod codegen run test-function # Create an isolated venv with codegen => open jupyter @@ -63,20 +65,18 @@ codegen notebook ## Usage -See [https://docs.codegen.com/introduction/getting-started] for a full tutorial. +See [Getting Started](https://docs.codegen.com/introduction/getting-started) for a full tutorial. ``` from codegen import Codebase - ``` ## Resources - [Docs](https://docs.codegen.com) -- [Get Started](https://docs.codegen.com/introduction/getting-started) +- [Getting Started](https://docs.codegen.com/introduction/getting-started) - [Contributing](CONTRIBUTING.md) - ## Why Codegen? 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.