From 1622e039629efd1c392b19bbc1715faeb94df542 Mon Sep 17 00:00:00 2001 From: Severin Ibarluzea Date: Fri, 10 Oct 2025 13:22:38 -0700 Subject: [PATCH] docs: showcase example output URLs --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index aeedb47..6f02dab 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,15 @@ A server that takes encoded tscircuit code or circuit JSON and renders it into SVG or PNG assets suitable for use in docs. +## Example Output URLs + +| View | Preview | +| --- | --- | +| PCB Layout (SVG) | [![Example PCB layout generated by svg.tscircuit.com](https://svg.tscircuit.com/?svg_type=pcb&code=H4sIAJsBqGcAA42QvQ6CMBRGd57iphMMQlFH6ELiAzC5llJso%2F1JqdHE%2BO422AbD5Hi%2BnJuTXP60xnkY%2BUTvNw95AS2BPANoBkPdCA85etGiGiuFQHB5ET4SCVLQHJ%2Fl7I1bCOCLVDMetCuK62SMt07qcIuPeJ9mTVXQ%2BjrxzMS5fR3eES0bVqxij1FLmVyDkWMRY2xPf1W7TXW3ySZOXe8o4zA5o1pU9jUQKK3UNQJvwtD9DMtFUy3%2FI1nxAdzwix5iAQAA)](https://svg.tscircuit.com/?svg_type=pcb&code=H4sIAJsBqGcAA42QvQ6CMBRGd57iphMMQlFH6ELiAzC5llJso%2F1JqdHE%2BO422AbD5Hi%2BnJuTXP60xnkY%2BUTvNw95AS2BPANoBkPdCA85etGiGiuFQHB5ET4SCVLQHJ%2Fl7I1bCOCLVDMetCuK62SMt07qcIuPeJ9mTVXQ%2BjrxzMS5fR3eES0bVqxij1FLmVyDkWMRY2xPf1W7TXW3ySZOXe8o4zA5o1pU9jUQKK3UNQJvwtD9DMtFUy3%2FI1nxAdzwix5iAQAA) | +| Schematic (SVG) | [![Example schematic generated by svg.tscircuit.com](https://svg.tscircuit.com/?svg_type=schematic&code=H4sIAJsBqGcAA42QvQ6CMBRGd57iphMMQlFH6ELiAzC5llJso%2F1JqdHE%2BO422AbD5Hi%2BnJuTXP60xnkY%2BUTvNw95AS2BPANoBkPdCA85etGiGiuFQHB5ET4SCVLQHJ%2Fl7I1bCOCLVDMetCuK62SMt07qcIuPeJ9mTVXQ%2BjrxzMS5fR3eES0bVqxij1FLmVyDkWMRY2xPf1W7TXW3ySZOXe8o4zA5o1pU9jUQKK3UNQJvwtD9DMtFUy3%2FI1nxAdzwix5iAQAA)](https://svg.tscircuit.com/?svg_type=schematic&code=H4sIAJsBqGcAA42QvQ6CMBRGd57iphMMQlFH6ELiAzC5llJso%2F1JqdHE%2BO422AbD5Hi%2BnJuTXP60xnkY%2BUTvNw95AS2BPANoBkPdCA85etGiGiuFQHB5ET4SCVLQHJ%2Fl7I1bCOCLVDMetCuK62SMt07qcIuPeJ9mTVXQ%2BjrxzMS5fR3eES0bVqxij1FLmVyDkWMRY2xPf1W7TXW3ySZOXe8o4zA5o1pU9jUQKK3UNQJvwtD9DMtFUy3%2FI1nxAdzwix5iAQAA) | +| Pinout (SVG) | [![Example pinout generated by svg.tscircuit.com](https://svg.tscircuit.com/?svg_type=pinout&code=H4sIAJsBqGcAA22R0WvCMBDG3%2FtXHHlSGIrbuklZBVdFBdlE695rjFvAJiG5glL6v%2B9aqy6wPH35kbsv953MjbYIeDYCSkh0nmu1zM66wJXVxkEFB6tzYOi4tLyQyIJAKhT2kHEBlzfihELt3T%2FVZaCyXETg0Er1HVRBIE6NH9fKIYzDMExlLizE0DF1RXRp2YV4RMUAVmBhFXRIvu10ZvcjUqT5jzSNAqgdYrYdsPZ%2B0BoN2WHMnJZ8eOVG0td24ujisu58g4MI2FeSsIe%2F8JHgZLFJ5j5%2BIpzO19ONj58JJ%2Bl66dOQ6Oxj4sOXusN6MfPpK9HPberDIUGymqbXCaqqFWWv12viuoL6%2BRgp5F2BwhsQgGaLmizvRyp%2BLPZiod7rSFdS0cIiQFuI%2BwfI7n5pnftt%2Bv3bKrpB9Qv5iw%2BpQgIAAA%3D%3D)](https://svg.tscircuit.com/?svg_type=pinout&code=H4sIAJsBqGcAA22R0WvCMBDG3%2FtXHHlSGIrbuklZBVdFBdlE695rjFvAJiG5glL6v%2B9aqy6wPH35kbsv953MjbYIeDYCSkh0nmu1zM66wJXVxkEFB6tzYOi4tLyQyIJAKhT2kHEBlzfihELt3T%2FVZaCyXETg0Er1HVRBIE6NH9fKIYzDMExlLizE0DF1RXRp2YV4RMUAVmBhFXRIvu10ZvcjUqT5jzSNAqgdYrYdsPZ%2B0BoN2WHMnJZ8eOVG0td24ujisu58g4MI2FeSsIe%2F8JHgZLFJ5j5%2BIpzO19ONj58JJ%2Bl66dOQ6Oxj4sOXusN6MfPpK9HPberDIUGymqbXCaqqFWWv12viuoL6%2BRgp5F2BwhsQgGaLmizvRyp%2BLPZiod7rSFdS0cIiQFuI%2BwfI7n5pnftt%2Bv3bKrpB9Qv5iw%2BpQgIAAA%3D%3D) | +| 3D Render (PNG) | [![Example 3D render generated by svg.tscircuit.com](https://svg.tscircuit.com/?svg_type=3d&format=png&code=H4sIAJsBqGcAA0utKMgvKlFISU1LLM0pUdDQVLC1U9DgUlCwScpPLEqxA7KA7OSMzAIwS0EhLzE31VYp1FAJyk%2FLzy8pKMrMK7FVKs7PTLaAiOuDNNroQ83QBADwxaUxZgAAAA%3D%3D)](https://svg.tscircuit.com/?svg_type=3d&format=png&code=H4sIAJsBqGcAA0utKMgvKlFISU1LLM0pUdDQVLC1U9DgUlCwScpPLEqxA7KA7OSMzAIwS0EhLzE31VYp1FAJyk%2FLzy8pKMrMK7FVKs7PTLaAiOuDNNroQ83QBADwxaUxZgAAAA%3D%3D) | + ## API Overview This service converts TSCircuit code or pre-generated circuit JSON into various visual formats (PCB, schematic, and 3D views) via HTTP requests. It's designed to be used for generating circuit diagrams, PCB layouts, and 3D visualizations for documentation and web applications.