Add basic readme for litlytics library and add example code

Author: yamalight

packages/litlytics/README.md

@@ -1,15 +1,47 @@
-# litlytics
+# LitLytics
 
-To install dependencies:
+**LitLytics** is an affordable, simple analytics platform that leverages LLMs to automate data analysis.
+It was designed to help teams without dedicated data scientists gain insights from their data.
+
+This is a library that allows running pipelines in browser or server environments.
+
+## Installing
+
+Make sure you have npm-compatible package manager installed (e.g. [Bun](https://bun.sh/)).
+
+Then, install LitLytics from [npm](https://npm.com/packages/litlytics) by running following command:
 
 ```bash
-bun install
+bun add litlytics
 ```
 
-To run:
+## Using litlytics package to run pipelines
 
-```bash
-bun run litlytics.ts
+Once you have library installed, you can run your pipeline configs like shown in [example](./example/run.ts) below:
+
+```javascript
+import { LitLytics, type Pipeline } from '../litlytics';
+import pipeline from './pipeline.json';
+
+// create new instance with provider/model of your choice
+const litlytics = new LitLytics({
+  provider: 'openai',
+  model: 'gpt-4o-mini',
+  key: process.env.OPENAI_API_KEY,
+});
+// set pipeline config
+litlytics.setPipeline(pipeline);
+// execute pipeline
+const result = await litlytics.runPipeline();
+// read results
+console.log(result?.results);
 ```
 
-This project was created using `bun init` in bun v1.1.29. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+## License
+
+This project is [licensed](/LICENSE.md) under the **GNU Affero General Public License v3.0 (AGPL-3.0)**.
+This license ensures that the software remains free and open, even when used as part of a network service. If you modify or distribute the project (including deploying it as a service), you must also make your changes available under the same license.
+
+### Commercial/Enterprise Licensing
+
+If your use case requires a proprietary license (for example, you do not wish to open-source your modifications or need a more flexible licensing arrangement), we offer **commercial and enterprise licenses**. Please [contact us](mailto:[email protected]?subject=LitLytics%20License) to discuss licensing options tailored to your needs.

packages/litlytics/example/pipeline.json

@@ -0,0 +1,52 @@
+{
+  "name": "instagram-example",
+  "pipelinePlan": "",
+  "pipelineDescription": "",
+  "source": {
+    "id": "source_0",
+    "name": "Source",
+    "description": "Primary source",
+    "type": "source",
+    "sourceType": "text",
+    "docs": [
+      {
+        "id": "textdoc",
+        "name": "Default document",
+        "content": "Post is a photo of my cute black cat with white mustache.",
+        "test": true,
+        "processingResults": []
+      }
+    ],
+    "connectsTo": [
+      "step_0"
+    ],
+    "expanded": true
+  },
+  "steps": [
+    {
+      "id": "step_0",
+      "name": "Write an instagram post",
+      "description": "Write a post for instagram based on text description of the image.",
+      "type": "llm",
+      "input": "doc",
+      "prompt": "Create an engaging Instagram post based on the provided text description of the image.\nHighlight key elements, emotions, and any relevant hashtags to enhance visibility and engagement.\nEnsure the tone is suitable for Instagram, aiming to captivate the audience and encourage interaction.\nUse simpler language. Write as if you are not a native English speaker.",
+      "connectsTo": [
+        "step_1"
+      ],
+      "expanded": true
+    },
+    {
+      "id": "step_1",
+      "name": "Proof-read and edit instagram post text",
+      "description": "Proof-read and edit instagram post text to make it more natural and engaging.",
+      "type": "llm",
+      "input": "result",
+      "prompt": "Please proofread and edit the provided Instagram post text to enhance its natural flow and engagement.\nFocus on improving grammar, clarity, and overall appeal to the audience, while maintaining the original message and tone.",
+      "connectsTo": [
+        "litlytics_output"
+      ],
+      "expanded": true
+    }
+  ],
+  "results": []
+}

packages/litlytics/example/run.ts

@@ -0,0 +1,11 @@
+import { LitLytics, type Pipeline } from '../litlytics';
+import pipeline from './pipeline.json';
+
+const litlytics = new LitLytics({
+  provider: 'openai',
+  model: 'gpt-4o-mini',
+  key: process.env.OPENAI_API_KEY!,
+});
+litlytics.setPipeline(pipeline as Pipeline);
+const result = await litlytics.runPipeline();
+console.log(result?.results);