Add readme

oxc-project · Jul 7, 2024 · 0b85f83 · 0b85f83
1 parent abbd977
commit 0b85f83
Showing 1 changed file with 13 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,3 +1,15 @@
-# oxc-node
+# `oxc-node`
+
+[![CI](https://github.com/oxc-project/oxc-node/actions/workflows/CI.yml/badge.svg)](https://github.com/oxc-project/oxc-node/actions/workflows/CI.yml)
 
 Fast and friendly Node.js devtools based on [OXC](https://github.com/oxc-project/oxc)
+
+## `@oxc/node-core`
+
+Transformer and register for Node.js projects.
+
+### Usage
+
+```bash
+node --import @oxc/node-core ./path/to/entry.ts
+```