Skip to content

Commit 54919b4

Browse files
committed
docs(readme): add registry badges, Install section, and nav link
Add crates.io, PyPI, npm, docs.rs, and CI status badges. Add an Install section with a per-ecosystem package table covering Rust, Python, and Node/Bun. Add an Install anchor to the nav strip.
1 parent b20fda4 commit 54919b4

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,12 @@
77
<p>
88
A purpose-neutral, language-agnostic code-graph extraction library. It turns source code into
99
</br><strong>symbols</strong>, <strong>references</strong>, and <strong>cross-file edges</strong> (calls, imports, …)
10-
</br>as plain data — and stops there.
10+
</br>as plain data — and stops there.
1111
</p>
1212

1313
<p>
14+
<a href="#install"><strong>Install</strong></a>
15+
·
1416
<a href="#quickstart"><strong>Quickstart</strong></a>
1517
·
1618
<a href="#languages"><strong>Languages</strong></a>
@@ -26,6 +28,14 @@ A purpose-neutral, language-agnostic code-graph extraction library. It turns sou
2628
</a>
2729
</p>
2830

31+
<p>
32+
<a href="https://crates.io/crates/code2graph"><img src="https://img.shields.io/crates/v/code2graph?logo=rust" alt="crates.io"></a>
33+
<a href="https://pypi.org/project/code2graph-rs/"><img src="https://img.shields.io/pypi/v/code2graph-rs?logo=pypi&logoColor=white&label=pypi" alt="PyPI"></a>
34+
<a href="https://www.npmjs.com/package/code2graph-rs"><img src="https://img.shields.io/npm/v/code2graph-rs?logo=npm" alt="npm"></a>
35+
<a href="https://docs.rs/code2graph"><img src="https://img.shields.io/docsrs/code2graph?logo=docsdotrs&logoColor=white" alt="docs.rs"></a>
36+
<a href="https://github.com/nodedb-lab/code2graph/actions/workflows/ci.yml"><img src="https://github.com/nodedb-lab/code2graph/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
37+
</p>
38+
2939
<p>
3040
<img src="https://img.shields.io/badge/license-Apache--2.0-blue" alt="License: Apache-2.0">
3141
<img src="https://img.shields.io/badge/rustc-1.85%2B-orange" alt="MSRV 1.85">
@@ -69,6 +79,18 @@ Reach for it when:
6979

7080
It's **not** for you if you want a turnkey, batteries-included code-intelligence product. Code2graph is the substrate _beneath_ that, not the product itself.
7181

82+
## Install
83+
84+
code2graph ships to three ecosystems from a single source — the Rust crate plus native bindings that emit the same neutral facts as language-native objects:
85+
86+
| Ecosystem | Package | Install |
87+
| ---------- | -------------------------------------------------------------- | --------------------------- |
88+
| Rust | [`code2graph`](https://crates.io/crates/code2graph) | `cargo add code2graph` |
89+
| Python | [`code2graph-rs`](https://pypi.org/project/code2graph-rs/) | `pip install code2graph-rs` |
90+
| Node / Bun | [`code2graph-rs`](https://www.npmjs.com/package/code2graph-rs) | `npm install code2graph-rs` |
91+
92+
API reference: [docs.rs/code2graph](https://docs.rs/code2graph). Binding sources: [`bindings/python`](bindings/python) (PyO3 / maturin) and [`bindings/node`](bindings/node) (napi-rs).
93+
7294
## Quickstart
7395

7496
The pipeline is two pure, deterministic stages:

0 commit comments

Comments
 (0)