substarte 120240617.1.9

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Substrate
+
+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

@@ -0,0 +1,65 @@
+# Substrate TypeScript SDK
+
+[![NPM version](https://img.shields.io/npm/v/substrate.svg)](https://npmjs.org/package/substrate)
+
+Substrate is a **powerful SDK** for building with AI, with [batteries included](https://substrate.run/nodes): language models, image generation, built-in vector storage, sandboxed code execution, and more. To use Substrate, you simply connect tasks, and then run the workflow. With this simple approach, we can create AI systems (from RAG, to agents, to multi-modal generative experiences) by simply describing the computation, with **zero additional abstractions**.
+
+Substrate is also a **workflow execution** and **inference** engine, optimized for running compound AI workloads. Wiring together multiple inference APIs is inherently slow – whether you do it yourself, or use a framework like LangChain. Substrate lets you ditch the framework, write less code, and run compound AI fast.
+
+## Documentation
+
+If you're just getting started, head to [docs.substrate.run](https://docs.substrate.run/).
+
+For a detailed API reference covering the nodes available on Substrate, see [substrate.run/nodes](https://www.substrate.run/nodes).
+
+## Installation
+
+```sh
+npm install substrate
+```
+
+## Usage
+
+```typescript
+import { Substrate, ComputeText, sb } from "substrate";
+```
+
+Initialize the Substrate client.
+
+```typescript
+const substrate = new Substrate({ apiKey: SUBSTRATE_API_KEY });
+```
+
+Generate a story using the [`ComputeText`](https://www.substrate.run/nodes#ComputeText) node.
+
+```typescript
+const story = new ComputeText({ prompt: "tell me a story" });
+```
+
+Summarize the output of the `story` node using another `ComputeText` node. Because `story` has not yet been run, we use `sb.interpolate` to work with its future output.
+
+```typescript
+const summary = new ComputeText({
+  prompt: sb.interpolate`summarize this story in one sentence: ${story.future.text}`,
+});
+```
+
+Run the graph chaining `story` → `summary` by passing the terminal node to `substrate.run`.
+
+```typescript
+const response = await substrate.run(summary);
+```
+
+Get the output of the summary node by passing it to `response.get`.
+
+```typescript
+const summaryOut = response.get(summary);
+console.log(summaryOut.text);
+// Princess Lily, a kind-hearted young princess, discovers a book of spells and uses it to grant her family and kingdom happiness.
+```
+
+## Examples
+
+We're always creating new JS examples on [val.town](https://www.val.town/u/substrate/folders/Examples?folderId=61e21628-4209-11ef-bf47-de64eea55b61).
+
+Many examples are also included in the `examples` directory.