Skip to content

Commit

Permalink
add more instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
seveibar committed Dec 29, 2024
1 parent bf63cfe commit cf06089
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,27 @@

Convert Circuit JSON into a readable netlist suitable for input to AI

[![npm version](https://badge.fury.io/js/circuit-json-to-readable-netlist.svg)](https://badge.fury.io/js/circuit-json-to-readable-netlist) [![GitHub](https://img.shields.io/github/stars/tscircuit/circuit-json-to-readable-netlist?style=social)](https://github.com/tscircuit/circuit-json-to-readable-netlist)[tscircuit](https://github.com/tscircuit/tscircuit)[discord](https://tscircuit.com/join)[use tscircuit online](https://tscircuit.com)

## Installation

```bash
bun add circuit-json-to-readable-netlist
```

## Usage

### TypeScript

```typescript
import { convertCircuitJsonToReadableNetlist } from 'circuit-json-to-readable-netlist'
import type { CircuitJson } from 'circuit-json'

const circuitJson: CircuitJson = // ... your circuit JSON
const readableNetlist = convertCircuitJsonToReadableNetlist(circuitJson)
console.log(readableNetlist)
```

## Example Readable Netlist

```txt
Expand Down

0 comments on commit cf06089

Please sign in to comment.