circuit-json-to-connectivity-map 0.0.1 → 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 tscircuit Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,4 +1,13 @@
-# circuit-json-to-connectivity-map
+# Circuit JSON to Connectivity Map
+
+This project provides utilities to generate connectivity maps from circuit JSON data. It's designed to work with the `@tscircuit/soup` library and offers functionality to find connected networks and create source port connectivity maps.
+
+## Features
+
+- Find connected networks from a list of connections
+- Generate source port connectivity maps from circuit JSON data
+
+## Installation
 
 To install dependencies:
 
@@ -6,10 +15,60 @@ To install dependencies:
 bun install
 ```
 
-To run:
+## Usage
+
+### Finding Connected Networks
+
+```typescript
+import { findConnectedNetworks } from "circuit-json-to-connectivity-map"
+
+const connections = [
+  ["A", "B"],
+  ["B", "C"],
+  ["D", "E"],
+]
+
+const result = findConnectedNetworks(connections)
+console.log(result)
+```
+
+### Generating Source Port Connectivity Map
+
+```typescript
+import { getSoupPortConnectivityMapFromCircuitJson } from "circuit-json-to-connectivity-map"
+import type { AnySoupElement } from "@tscircuit/soup"
+
+const circuitJson: AnySoupElement[] = [
+  // Your circuit JSON data here
+]
+
+const connectivityMap = getSoupPortConnectivityMapFromCircuitJson(circuitJson)
+console.log(connectivityMap)
+```
+
+## Running Tests
+
+To run the tests:
 
 ```bash
-bun run index.ts
+bun test
 ```
 
-This project was created using `bun init` in bun v1.1.21. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+## Development
+
+This project uses [Bun](https://bun.sh) as its JavaScript runtime. Bun is a fast all-in-one JavaScript runtime.
+
+To start development:
+
+1. Clone the repository
+2. Run `bun install` to install dependencies
+3. Make your changes
+4. Run `bun test` to ensure all tests pass
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+[MIT License](LICENSE)

package/package.json

@@ -2,7 +2,7 @@
   "name": "circuit-json-to-connectivity-map",
   "module": "dist/index.js",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "files": [
     "dist"
   ],