Skip to content

Add README.md and LICENSE#29

Merged
atdrendel merged 2 commits intomainfrom
add-readme
Mar 18, 2026
Merged

Add README.md and LICENSE#29
atdrendel merged 2 commits intomainfrom
add-readme

Conversation

@atdrendel
Copy link
Contributor

No description provided.

Copilot AI review requested due to automatic review settings March 18, 2026 14:42
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds baseline repository documentation and licensing for the SHLLM Swift package so users can understand requirements, install via SPM, and learn the core API surface.

Changes:

  • Introduces a comprehensive README.md covering installation, streaming usage patterns, model families, configuration, and examples.
  • Adds an MIT LICENSE file.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
README.md New package documentation, usage examples, supported models list, and configuration notes.
LICENSE Adds MIT license text for the repository.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.


## Requirements

- Swift 5.12+
Comment on lines +197 to +199
| Family | Model Type | Factory Method |
|---|---|---|
| DeepSeek R1 | `Qwen2Model` | `deepSeekR1` |
| **Qwen 3.5 MoE** | `Qwen35MoE` | `qwen3_5MoE` |
| SmolLM | `LlamaModel` | `smolLM` |

Each factory method takes `directory`, `input`, and optional parameters for `tools`, `maxInputTokenCount`, and `maxOutputTokenCount`.
@atdrendel atdrendel merged commit b4ec04c into main Mar 18, 2026
1 check passed
@atdrendel atdrendel deleted the add-readme branch March 18, 2026 17:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants