@vedangiitb/qwintly-core 1.5.0 → 1.6.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vedang Bale
+
+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,8 +1,16 @@
 # qwintly-core
 
-A shared package consisting of 
-1. Shared AI tools
-2. Project indexer
-3. Status logging
+A shared package consisting of:
+1. **Shared AI Tools**: Modular schemas and implementations optimized for planning and layout manipulation.
+2. **Project Indexer**: Codebase analytics, configuration extraction, and metadata indexing for routes.
+3. **Status Logging**: Real-time progress streaming via database and Redis Pub/Sub channels.
 
-These components are used in qwintly website generator project
+These components power the qwintly website generator project.
+
+## 📖 Documentation
+
+For a detailed walkthrough of the internal design, system schemas, and flow mechanics, see the [Architecture & Tool Loop Reference Guide](ARCHITECTURE.md). It covers:
+* **The Tool Ecosystem**: Schemas, implementations, and safety guardrails.
+* **The `toolLoop` Execution Flow**: Multi-turn iteration timelines and retries.
+* **Smart Context Management**: Argument redaction, compaction, and file read capping.
+* **Model Output & State Persistence**: Supabase logging, token auditing, and Redis streaming.